{"info":{"_postman_id":"b674ee96-1a88-7f1d-9306-d0e0be3eb00b","name":"Finly API V1","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"1725208","collectionId":"b674ee96-1a88-7f1d-9306-d0e0be3eb00b","publishedId":"6Z3sXND","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-06-05T19:50:19.000Z"},"item":[{"name":"Authentication","item":[{"name":"Authenticate","event":[{"listen":"test","script":{"id":"1062aa27-41a9-41ef-bcd7-c85a32a75c12","exec":["var jsonData = JSON.parse(responseBody)","postman.setEnvironmentVariable(\"token\", jsonData.access_token)"],"type":"text/javascript"}}],"id":"bbbbfc31-acb9-4676-bc7f-0fceefc36505","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"{{email}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"}]},"url":"{{host}}/api/fm/v1/auth.json","urlObject":{"path":["api","fm","v1","auth.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"fa5038eb-a88c-44b4-a7df-0f811a3204a6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"","value":"","disabled":true},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"{{email}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"}]},"url":"{{host}}/api/fm/v1/auth.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"460c04af7e5007fa38daa67a9c19994a\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"access_token=ecd9b68ca68276c69e70bd397db190a6; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Set-Cookie","value":"refresh_token=311b06af7d449bae96cb536302cce890; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Set-Cookie","value":"_Finly_session=SjVnODVBT2dGNmxKbmgvaGl6bW8xOWhUc1pCMHNKRDRYdTk4VkkrTEdwSEFxOHZsb1NxNEo0NmhKSFplNXRHWFVmNWp4T1E5ckFlQ2VEOXhvbEp2eDR2S1JJRmtzMzBTTDdmVW1SMHh0NmdpZ05pdzVHd2tTTnNQSitLbituUjM5TVNCNEZDMmtCVGlWTXR5dExxbUFRPT0tLVBSV0VVSUllNjhWRFVRWW5vbXorZ1E9PQ%3D%3D--152a5ca3dca6e32003d9a996601d993d0a54b6c8; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"0e0ea5cf-b06c-433a-90e1-4781d3154ed8","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.238800","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"SjVnODVBT2dGNmxKbmgvaGl6bW8xOWhUc1pCMHNKRDRYdTk4VkkrTEdwSEFxOHZsb1NxNEo0NmhKSFplNXRHWFVmNWp4T1E5ckFlQ2VEOXhvbEp2eDR2S1JJRmtzMzBTTDdmVW1SMHh0NmdpZ05pdzVHd2tTTnNQSitLbituUjM5TVNCNEZDMmtCVGlWTXR5dExxbUFRPT0tLVBSV0VVSUllNjhWRFVRWW5vbXorZ1E9PQ%3D%3D--152a5ca3dca6e32003d9a996601d993d0a54b6c8","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"ecd9b68ca68276c69e70bd397db190a6","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"311b06af7d449bae96cb536302cce890","key":"refresh_token"}],"responseTime":null,"body":"{\"access_token\":\"ecd9b68ca68276c69e70bd397db190a6\",\"token_type\":\"bearer\",\"refresh_token\":\"311b06af7d449bae96cb536302cce890\",\"expires_in\":2591999}"}],"_postman_id":"bbbbfc31-acb9-4676-bc7f-0fceefc36505"},{"name":"Signout","id":"7261453f-0027-add7-8814-e903896abcaf","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/api/fm/v1/auth.json","description":"

This destroyes the Access Token which is generated using the Authentication API

\n","urlObject":{"path":["api","fm","v1","auth.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"656b9b47-53d9-a7f9-06c0-67a059947752","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}","enabled":true,"disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/users/sign_out.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"ETag","value":"W/\"7363e85fe9edee6f053a4b319588c086\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Set-Cookie","value":"_Finly_session=VWVpL3YvbEhQdWlzeHQ3RXZucmY4WTRaMG82R01SallnaDQvd1hqUlFqTXorVWErTlRqT1JFWkljQlFqQlAweHBUNXdZUkF4aGhLWWsvN2dSZERNYVE9PS0tOGdkbFMyS0EwYTZJaUJpWmt5ZXVSQT09--dfe9605ad9b482709460d1d2f0b7248da7cd7df3; path=/; HttpOnly","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Set-Cookie","value":"access_token=; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Set-Cookie","value":"refresh_token=; path=/; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":"Custom header"},{"key":"X-Request-Id","value":"2109b705-2ed3-4410-8928-5f289068ffb1","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.073436","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"VWVpL3YvbEhQdWlzeHQ3RXZucmY4WTRaMG82R01SallnaDQvd1hqUlFqTXorVWErTlRqT1JFWkljQlFqQlAweHBUNXdZUkF4aGhLWWsvN2dSZERNYVE9PS0tOGdkbFMyS0EwYTZJaUJpWmt5ZXVSQT09--dfe9605ad9b482709460d1d2f0b7248da7cd7df3","key":"_Finly_session"}],"responseTime":"92","body":"{\"success\":true}"}],"_postman_id":"7261453f-0027-add7-8814-e903896abcaf"}],"id":"bcf222b9-288d-cb2b-7496-d32534f80e84","_postman_id":"bcf222b9-288d-cb2b-7496-d32534f80e84","description":""},{"name":"Vendors","item":[{"name":"Index","id":"2def35f9-a5d3-43e9-8b84-6eec4934a214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{host}}/api/vp/v1/vendors.json?page=1","description":"

Response.\nIndex API will return array of vendors.

\n

Response key

\n\n","urlObject":{"path":["api","vp","v1","vendors.json"],"host":["{{host}}"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"2def35f9-a5d3-43e9-8b84-6eec4934a214"}],"id":"71e78336-7170-4f86-843a-46caf4e6d9b3","description":"

Vendor index list. Each record comprises vendor details, associated gstin location details and bank account details

\n","_postman_id":"71e78336-7170-4f86-843a-46caf4e6d9b3"},{"name":"User","item":[{"name":"Index","id":"c539c415-c88a-8e75-3faa-42d686724056","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/users.json?page=1&size=30","description":"

This lists all created users

\n

Params

\n\n","urlObject":{"path":["api","fm","v1","users.json"],"host":["{{host}}"],"query":[{"key":"page","value":"1"},{"key":"size","value":"30"}],"variable":[]}},"response":[{"id":"56200331-fa9a-127c-2414-83906097726e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":{"raw":"{{host}}/api/fm/v1/users.json?page=1&size=30","host":["{{host}}"],"path":["api","fm","v1","users.json"],"query":[{"key":"page","value":"1"},{"key":"size","value":"30"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"b02377a0e5839d60086efcca3815b63d\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=LzlOMytuYmtsOE5DS2RXajBQdVc4UzhhUVVJMlFmU1NvZ2UwMVFFRFM1NEl2YWdIVkIycndKYndXVWx2MFNmMXpEaSt6Nmt4U1NIZmVrQlpPQzFSeGoxdmNWUWtSOW1WRnAwb0hUU01Ba25uaE1QUzhnaTRQSHRzRXVtc2lBK3pqWlpUMVluS1laR08vWHhyQXp6bUp3PT0tLU5pUzc5VndjWEpTejAxeVdWRUNNNUE9PQ%3D%3D--4651edfbcdd7bcb0cbeb15b4b95c370df061c19b; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"dafab1ba-2adf-4900-97ad-7ae23321cf8a","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.525578","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"LzlOMytuYmtsOE5DS2RXajBQdVc4UzhhUVVJMlFmU1NvZ2UwMVFFRFM1NEl2YWdIVkIycndKYndXVWx2MFNmMXpEaSt6Nmt4U1NIZmVrQlpPQzFSeGoxdmNWUWtSOW1WRnAwb0hUU01Ba25uaE1QUzhnaTRQSHRzRXVtc2lBK3pqWlpUMVluS1laR08vWHhyQXp6bUp3PT0tLU5pUzc5VndjWEpTejAxeVdWRUNNNUE9PQ%3D%3D--4651edfbcdd7bcb0cbeb15b4b95c370df061c19b","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"550","body":"[\n {\n \"id\": 1,\n \"name\": \"Rajesh Kumar\",\n \"mobile_number\": \"8099498652\",\n \"email\": \"rajesh@companyx.com\",\n \"finly_money\": {\n \"id\": 1,\n \"balance\": {\n \"value\": \"0.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n }\n },\n \"cards\": [\n {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"active\": true,\n \"ending_number\": \"7974\",\n \"description\": \"Test physical card for user 1\",\n \"balance\": {\n \"value\": \"5190.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"eligibility\": {\n \"value\": \"4810.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"disabled_by\": null\n }\n ],\n \"roles\": {\n \"admin\": true,\n \"finance_manager\": false\n }\n },\n {\n \"id\": 2,\n \"name\": \"Suraj Joshi\",\n \"mobile_number\": \"7984332131\",\n \"email\": \"suraj@companyx.com\",\n \"finly_money\": {\n \"id\": 2,\n \"balance\": {\n \"value\": \"0.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n }\n },\n \"cards\": [\n {\n \"id\": 2,\n \"serial_id\": \"S00017740091\",\n \"active\": true,\n \"ending_number\": \"2957\",\n \"description\": \"Test physical card for user 2\",\n \"balance\": {\n \"value\": \"6373.01\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"eligibility\": {\n \"value\": \"3626.99\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"disabled_by\": null\n }\n ],\n \"roles\": {\n \"admin\": false,\n \"finance_manager\": true\n }\n }\n]"}],"_postman_id":"c539c415-c88a-8e75-3faa-42d686724056"},{"name":"Add user","id":"e68a9f30-e0c7-1010-a7f3-aa3168ee22bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Test\",\n \"last_name\": \"User7\",\n \"mothers_maiden_name\": \"Test01\",\n \"mobile_number\": \"6767131818\",\n \"email\": \"test1@test6.com\",\n \"date_of_birth\": \"10-12-1980\",\n \"gender\": \"Male\",\n \"address_1\": \"Sadhana Apts\",\n \"address_2\": \"Koramangala\",\n \"city\": \"Bangalore\",\n \"state_id\": 1,\n \"pin_code\": \"560027\",\n \"employee_id\": \"EMP10001\",\n \"payroll_id\": \"PAYROLL11002\",\n \"expense_management\": true,\n \"vendor_payments\": true,\n \"disburse_panel\": false,\n \"invoicing\": false\n}"},"url":"{{host}}/api/fm/v1/users.json","description":"

This API will be used to create a particular user in Finly.

\n

Parameters: (ones marked with * are mandatory)

\n\n

The following parameters decide which all panels the user will be a part of. You can find this user in the respective 'Users' section of each dashboard in which they are enabled

\n\n

This API will create the user in Finly in an pending_activation status in Finly that will be activated once the approval workflows and roles are set from the dashboard. You can contact your implementation manager to learn how to set approval flows.

\n","urlObject":{"path":["api","fm","v1","users.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"6a1db7e2-1892-a2b2-70b0-c670a14356cf","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Rakesh\",\n \"last_name\": \"Gupta\",\n \"mothers_maiden_name\": \"Sharma\",\n \"mobile_number\": \"8105739684\",\n \"email\": \"rakesh.g2@gmail.com\",\n \"date_of_birth\": \"10-12-1980\",\n \"gender\": \"m\",\n \"address_1\": \"Sadhana Apts\",\n \"address_2\": \"Koramangala\",\n \"city\": \"Bangalore\",\n \"state_id\": 1,\n \"pin_code\": \"560027\",\n \"employee_id\": \"EMP10001\",\n \"payroll_id\": \"PAYROLL11002\",\n \"expense_management\": true,\n \"vendor_payments\": true,\n \"disburse_panel\": false,\n \"invoicing\": false,\n \"expense_management_roles\": {\n \t\"admin\": false,\n \t\"finance_manager\": false,\n \t\"manager\": true\n },\n \"vendor_payments_roles\": {\n \t\"admin\": true,\n \t\"creditor\": false,\n \t\"reviewer\": false\n }\n}"},"url":"{{host}}/api/fm/v1/users.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"7faa698b17e825e6295daf8dacf2439a\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=V0d4WlVpOGVPam0rSXkvbjZYdnhxaFNsbHpHMkh1YVgzaGdqa2c2WjJqU1NVbkIzbVJtRGpneHE5eWplWFUyT1lDVXdqenNvRE4zSmlRcUhHajlsYUlva3lXWHByMmF0ZWh1Q0VaZXdjUFYxejZGUG5sdzkwbEhkaW1sNEVwWGpreEFETmpyOGhoekdlOEplWFhQc2lnPT0tLW9kZmRQem9GM0Jqc084WTdvUE4vR2c9PQ%3D%3D--d3b9118db0f68ec569a8ca4b840106f861860c63; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"8b672702-5cbe-458a-9e1d-3ebc7d40607e","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.468143","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"V0d4WlVpOGVPam0rSXkvbjZYdnhxaFNsbHpHMkh1YVgzaGdqa2c2WjJqU1NVbkIzbVJtRGpneHE5eWplWFUyT1lDVXdqenNvRE4zSmlRcUhHajlsYUlva3lXWHByMmF0ZWh1Q0VaZXdjUFYxejZGUG5sdzkwbEhkaW1sNEVwWGpreEFETmpyOGhoekdlOEplWFhQc2lnPT0tLW9kZmRQem9GM0Jqc084WTdvUE4vR2c9PQ%3D%3D--d3b9118db0f68ec569a8ca4b840106f861860c63","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"470","body":"{\"success\":true,\"messages\":{\"error\":[],\"failure\":[],\"success\":[\"User created\"],\"message\":[],\"notice\":[]}}"}],"_postman_id":"e68a9f30-e0c7-1010-a7f3-aa3168ee22bd"},{"name":"User Update details","event":[{"listen":"test","script":{"id":"317af7e5-8e28-4b37-a591-4fd5d49eadd5","exec":[""],"type":"text/javascript"}}],"id":"560dc22e-c444-93f8-be09-c2bcf91aeae7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"email\": \"\",\n \"type\": \"details\",\n \"employee_id\": \"QWERTY123\",\n \"first_name\": \"Rakesh\",\n \"last_name\": \"Gupta\",\n \"mobile_number\": \"9988998899\",\n \"mothers_maiden_name\": \"Sharma\",\n \"date_of_birth\": \"10-12-1982\",\n \"gender\": \"Male\",\n \"department_id\": \"3\",\n \"address_1\": \"91 Springboard\",\n \"address_2\": \"JP Nagar\",\n \"city\": \"Bangalore\",\n \"state_id\": 19,\n \"pin_code\": \"560076\",\n \"active\": true,\n \"location_id\": 10177,\n \"payroll_id\": \"PAYROLL11002\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/fm/v1/users/2.json","description":"

This API will allow you to update user's detail through APIs

\n

Parameters: (ones marked with * are mandatory)

\n\n

The following parameters decide which all panels the user will be a part of. You can find this user in the respective 'Users' section of each dashboard in which they are enabled

\n","urlObject":{"path":["api","fm","v1","users","2.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"545ed1dc-5da7-538d-df42-cc9c2f8fc5aa","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"status\",\n \"active\": true\n}"},"url":"{{host}}/api/fm/v1/users/2.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"98a1b4c75a082cc254a05d578ecde4e6\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=cDZqZlc4VEhVcHlHak5oK0dYWFVxMVcxamczTEtDT1ViWkhuTUpFMERXNlU2ZWU5a3VHMm9MVGdtMW95RDA0Qjkxa3VoU3FWSGhoNThGem5KMmRGbS9kZkwwZFRWMzczaWpiZkROaTVhQU1WeGl1emFmVFNEQkMyemkwRE02dE14RkRrNDd0c2xBbGF6QnNGQWVRbXVRPT0tLXp3QXNaazdLZlgwcmpUMjdVandGd1E9PQ%3D%3D--9625f63587d73971356b52acdbdbea7662e37811; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"f7f12453-0e9b-4575-b359-8dcc661fa8d5","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.130519","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"cDZqZlc4VEhVcHlHak5oK0dYWFVxMVcxamczTEtDT1ViWkhuTUpFMERXNlU2ZWU5a3VHMm9MVGdtMW95RDA0Qjkxa3VoU3FWSGhoNThGem5KMmRGbS9kZkwwZFRWMzczaWpiZkROaTVhQU1WeGl1emFmVFNEQkMyemkwRE02dE14RkRrNDd0c2xBbGF6QnNGQWVRbXVRPT0tLXp3QXNaazdLZlgwcmpUMjdVandGd1E9PQ%3D%3D--9625f63587d73971356b52acdbdbea7662e37811","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"140","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n }\n}"}],"_postman_id":"560dc22e-c444-93f8-be09-c2bcf91aeae7"},{"name":"Update user","id":"b4337361-03fe-44ca-9a13-c117e5c01938","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Rakesh\",\n \"last_name\": \"Gupta\",\n \"mothers_maiden_name\": \"Sharma\",\n \"date_of_birth\": \"10-12-1982\",\n \"gender\": \"m\",\n \"address_1\": \"Sadhana Apts\",\n \"address_2\": \"Koramangala\",\n \"city\": \"Bangalore\",\n \"state_id\": 1,\n \"pin_code\": \"560027\",\n \"employee_id\": \"EMP10001\",\n \"payroll_id\": \"PAYROLL11002\"\n}"},"url":"{{host}}/api/v1/users/15203.json","description":"

This API can be used to update the details of a particular user. Details involving their role, their manager mapping etc. can be done directly from the dashboard

\n

The {{user_id}} attribute in the URL defines the ID of the user that needs to be updated.

\n

Parameters: (ones marked with * are mandatory)

\n\n","urlObject":{"path":["api","v1","users","15203.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4337361-03fe-44ca-9a13-c117e5c01938"},{"name":"User Show","id":"07bd33c0-3b49-416b-9576-5832847fb8a3","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/api/v1/users/{{user_id}}.json","description":"

This API gives the details of a particular user within Finly. It will include the approval flow set for this particular user - shown Policy and Document wise.

\n","urlObject":{"path":["api","v1","users","{{user_id}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"07bd33c0-3b49-416b-9576-5832847fb8a3"}],"id":"92023ebf-1547-a86c-2488-14784f752b14","_postman_id":"92023ebf-1547-a86c-2488-14784f752b14","description":""},{"name":"Purchase Orders","item":[{"name":"Index","id":"0073d663-73a1-45b0-afba-5c06fd14d016","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{host}}/api/vp/v1/purchase_orders.json?filter_po_number=PO 2502","description":"

The API will give a list of the purchase orders and associated details

\n

The response contains An array of Purchase orders, each item in array comprise PO header details, line-item details and attachment details

\n

Response key pairs

\n\n","urlObject":{"path":["api","vp","v1","purchase_orders.json"],"host":["{{host}}"],"query":[{"disabled":true,"key":"page","value":"1"},{"key":"filter_po_number","value":"PO 2502"}],"variable":[]}},"response":[],"_postman_id":"0073d663-73a1-45b0-afba-5c06fd14d016"}],"id":"e5aca414-0a81-4490-bfe8-c8fbeed77a8a","description":"

Purchase order and associated line item details

\n","_postman_id":"e5aca414-0a81-4490-bfe8-c8fbeed77a8a"},{"name":"Prepaid Card","item":[{"name":"Funds","item":[{"name":"Credit","id":"d18fd4cf-cc11-2053-6741-cdee01dbb833","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1500,\n \"initiating_account_type\": \"virtual_account\",\n \"receiving_account_type\": \"card\",\n \"receiving_account_id\": \"S00017740090\",\n \"receiving_user_id\": \"\"\n}"},"url":"{{host}}/api/fm/v1/funds/credit.json","description":"

This API can Credit funds to Finly Money And Card

\n

Parameters:

\n\n","urlObject":{"path":["api","fm","v1","funds","credit.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"2fc76f37-2dcc-ad9a-10e9-1d61278614fb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 450,\n \"initiating_account_type\": \"virtual_account\",\n \"receiving_account_type\": \"card\",\n \"receiving_account_id\": \"S00017740090\",\n \"receiving_user_id\": \"\"\n}"},"url":"{{host}}/api/fm/v1/funds/credit.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"98a1b4c75a082cc254a05d578ecde4e6\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"7b54b03b-d806-4835-a35d-504c1a7c0f92","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"41.665027","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"41687","body":"{\"success\":true,\"messages\":{\"error\":[],\"failure\":[],\"success\":[],\"message\":[],\"notice\":[]}}"}],"_postman_id":"d18fd4cf-cc11-2053-6741-cdee01dbb833"},{"name":"Debit","id":"49c95222-97c9-53c2-1d7f-387d34ae2b3f","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1000,\n \"initiating_account_type\": \"virtual_account\",\n \"receiving_account_type\": \"card\",\n \"receiving_account_id\": \"S00017740090\",\n \"receiving_user_id\": \"This API can Debit funds to Finly Money And Card\n

This API can Debit funds to Finly Money And Card

\n

Parameters:

\n
    \n
  • amount: The amount that needs to be transferred
    • \n
  • initiating_account_type: The initiating account from which funds will be transferred. Can be virtual_account (i.e. company pool account) or wallet (i.e. Finly Money of a particular user)
    • \n
  • receiving_account_type: card or wallet depending on whether we are transferring to the Card or to Finly Money
    • \n
  • receiving_account_id: The serial number of the card (if the above attribute is card) or the ID of the user's Finly Money (if the above is wallet)
    • \n
  • receiving_user_id: ID / Email / Mobile Number of the user to whom the card belongs (to which money is bing transferred)
    • \n
\n","urlObject":{"path":["api","fm","v1","funds","debit.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ae4df3d2-4dcf-565b-237f-0c0e911509f2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 450,\n \"initiating_account\": \"finly_money\",\n \"initiating_account_type\": \"virtual_account\",\n \"receiving_account_type\": \"card\",\n \"receiving_account_id\": \"S00017740090\",\n \"receiving_user_id\": \"\"\n}"},"url":"{{host}}/api/fm/v1/funds/debit.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"678033548c166a28d0a8295589c3a1fa\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=eVVFY2RiWlU1eUVqZCtNb1k2SkZTSjRvSVdTSWNvUWlncnlUdmJ3QmhsU2hvamxiVmV0RExaaDBDN0xyVFlVWjY0OU1qZ1FqK0VnWWdqUi9MdzZjSzMrc2FyUytTbkw2Y3ZxVkRQS2lPam1XOUhabjV5SGdVcktmT1pUVnhZU3ItLW5abmZQOE8vRGZ5ZjlMbThabVFIL0E9PQ%3D%3D--b04e85f43e6a02e7faeafeb385b5dba0f5e1d0a0; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"b36f1fe4-63aa-4cdc-8077-25c4c8b3b9bf","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"16.986489","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"eVVFY2RiWlU1eUVqZCtNb1k2SkZTSjRvSVdTSWNvUWlncnlUdmJ3QmhsU2hvamxiVmV0RExaaDBDN0xyVFlVWjY0OU1qZ1FqK0VnWWdqUi9MdzZjSzMrc2FyUytTbkw2Y3ZxVkRQS2lPam1XOUhabjV5SGdVcktmT1pUVnhZU3ItLW5abmZQOE8vRGZ5ZjlMbThabVFIL0E9PQ%3D%3D--b04e85f43e6a02e7faeafeb385b5dba0f5e1d0a0","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"16993","body":"{\"success\":true,\"messages\":{\"error\":[],\"failure\":[],\"success\":[\"Debit successful\"],\"message\":[],\"notice\":[]}}"}],"_postman_id":"49c95222-97c9-53c2-1d7f-387d34ae2b3f"}],"id":"2f7e18d4-f46d-c37c-bdcf-1bbe456bbfd0","_postman_id":"2f7e18d4-f46d-c37c-bdcf-1bbe456bbfd0","description":""},{"name":"Card","item":[{"name":"Show","id":"e382af05-c2a1-2303-a12d-c611138b26d0","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/cards/1.json","description":"

This API retrieves a particular Card Information.

\n
\n

Response contains the follow details

\n
    \n
  • Card Balance - Current Balance of the Card
    • \n
  • Card Eligibility - Amount that can be loaded into the card
    • \n
  • Card Status - Unassigned / Active / Blocked
    • \n
  • Card Restrictions - All Restrictions(Transaction / MCC / Budget / End Date) applied on the card
    • \n
  • Card Program
    • \n
  • Card User
    • \n
\n","urlObject":{"path":["api","fm","v1","cards","1.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"946cda9f-e460-e057-19c7-b0deef8020c1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/cards/1.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"dc35fcddf4683aa9826e6a8a5c68c99b\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=NkpraVZrbkkrYVF6SzRNSDN5MHUxT2JTYjZGazZnU1RUelUyOEVDeVFpTzBkckZyYXArZzcyaldiM25tc1FhV0tpaENQcTBLM2pNQVNXNFhYVUdHVEpoTjdEZ21YVGZMSUVOUGdsNGpCdVFYZEFXeDRXWnJTeEZYODFFdDhzUlItLTNMSStrT3YxL2VyeEJOTFRHekswN0E9PQ%3D%3D--c6cf2f6cce96a7e558ed966d35a4a777c3624825; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"0e302f6f-ebac-4007-aae7-2c1bb4edc72d","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.357734","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"NkpraVZrbkkrYVF6SzRNSDN5MHUxT2JTYjZGazZnU1RUelUyOEVDeVFpTzBkckZyYXArZzcyaldiM25tc1FhV0tpaENQcTBLM2pNQVNXNFhYVUdHVEpoTjdEZ21YVGZMSUVOUGdsNGpCdVFYZEFXeDRXWnJTeEZYODFFdDhzUlItLTNMSStrT3YxL2VyeEJOTFRHekswN0E9PQ%3D%3D--c6cf2f6cce96a7e558ed966d35a4a777c3624825","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"8f83bb9187c6f706e1083d3647adf798","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"2097a17c95d0b04aa3c8dce60bd7a62f","key":"refresh_token"}],"responseTime":"361","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n },\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"active\": true,\n \"ending_number\": \"7974\",\n \"description\": \"Used for sales and marketing\",\n \"balance\": {\n \"value\": \"5190.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"eligibility\": {\n \"value\": \"4810.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"disabled_by\": null,\n \"assigned\": true,\n \"assigned_to_user\": {\n \"id\": 1,\n \"name\": \"Rajesh Kumar\",\n \"mobile_number\": \"8099498652\",\n \"email\": \"admin@finlytest.io\"\n },\n \"configurable_restrictions\": true,\n \"restrictions\": {\n \"channel_atm\": true,\n \"channel_ecom_pos\": true,\n \"mcc_group_id\": null,\n \"mcc_restriction_type\": null,\n \"limits\": {\n \"atm_limits\": [\n {\n \"id\": 4,\n \"period_id\": 1,\n \"period_name\": \"day\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 5,\n \"period_id\": 2,\n \"period_name\": \"week\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 6,\n \"period_id\": 3,\n \"period_name\": \"month\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n }\n ],\n \"ecom_pos_limits\": [\n {\n \"id\": 1,\n \"period_id\": 1,\n \"period_name\": \"day\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 2,\n \"period_id\": 2,\n \"period_name\": \"week\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 3,\n \"period_id\": 3,\n \"period_name\": \"month\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n }\n ]\n }\n }\n}"}],"_postman_id":"e382af05-c2a1-2303-a12d-c611138b26d0"},{"name":"Index","id":"a9ab70dd-131a-a2dc-78f5-559c414d585c","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/cards.json","description":"

This API retrieves a particular Card Information.

\n
\n

Response contains the follow details

\n
    \n
  • Card Balance - Current Balance of the Card
    • \n
  • Card Eligibility - Amount that can be loaded into the card
    • \n
  • Card Status - Unassigned / Active / Blocked
    • \n
  • Card Restrictions - All Restrictions(Transaction / MCC / Budget / End Date) applied on the card
    • \n
  • Card Program
    • \n
  • Card User
    • \n
\n","urlObject":{"path":["api","fm","v1","cards.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"fdbfe209-bd83-b563-09c8-5053e99ed106","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/cards.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"46d7a6008064e4f1bd81281fac3449ee\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=VEJJcEVFN0NKSWxHdUd3S0hmUUNXRytZTFVLUytiSGVaRERCMGJHRHlXTytBWkVDNWVqL01zSnkyM0hEQWVNdlc0c2hrN3NwVWVQdXBWZlZ1anlVQUNTR24xV0xBRXRQMWRWT2tka2ZyOGJ0K3Vld0F3cHFtVndwYU5zVmRIcjQtLURSczgrWW9ieHNlb2RtcHF3S0lzMkE9PQ%3D%3D--2bc84187ed02fbd59ec9256ecfedee2f14200832; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"fea81be6-90bb-44f4-be2f-e2b1b7be9eb5","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.164796","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"VEJJcEVFN0NKSWxHdUd3S0hmUUNXRytZTFVLUytiSGVaRERCMGJHRHlXTytBWkVDNWVqL01zSnkyM0hEQWVNdlc0c2hrN3NwVWVQdXBWZlZ1anlVQUNTR24xV0xBRXRQMWRWT2tka2ZyOGJ0K3Vld0F3cHFtVndwYU5zVmRIcjQtLURSczgrWW9ieHNlb2RtcHF3S0lzMkE9PQ%3D%3D--2bc84187ed02fbd59ec9256ecfedee2f14200832","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"8f83bb9187c6f706e1083d3647adf798","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"2097a17c95d0b04aa3c8dce60bd7a62f","key":"refresh_token"}],"responseTime":"184","body":"[\n {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"active\": true,\n \"ending_number\": \"7974\",\n \"description\": \"Used for sales and marketing\",\n \"balance\": {\n \"value\": \"5190.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"eligibility\": {\n \"value\": \"4810.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"disabled_by\": null,\n \"assigned\": true,\n \"assigned_to_user\": {\n \"id\": 1,\n \"name\": \"Rajesh Kumar\",\n \"mobile_number\": \"8099498652\",\n \"email\": \"rajesh@companyx.com\"\n }\n },\n {\n \"id\": 2,\n \"serial_id\": \"S00017740091\",\n \"active\": true,\n \"ending_number\": \"2957\",\n \"description\": \"Office Expenses\",\n \"balance\": {\n \"value\": \"6373.01\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"eligibility\": {\n \"value\": \"3626.99\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"disabled_by\": null,\n \"assigned\": true,\n \"assigned_to_user\": {\n \"id\": 2,\n \"name\": \"Suraj Joshi\",\n \"mobile_number\": \"7984332131\",\n \"email\": \"suraj@companyx.com\"\n }\n }\n]"}],"_postman_id":"a9ab70dd-131a-a2dc-78f5-559c414d585c"},{"name":"Transactions","id":"96350602-b6a0-fc89-8197-3a4d9031a1f4","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/cards/{{card_serial_id}}/transactions.json?page=1&size=30","description":"

This API retrieves the card transactions

\n
\n

Params

\n
    \n
  • size - Number of transactions per page. Default is 30
    • \n
  • page - Defines the page to retrieve the transactions for
    • \n
\n","urlObject":{"path":["api","fm","v1","cards","{{card_serial_id}}","transactions.json"],"host":["{{host}}"],"query":[{"description":{"content":"

Defines the page to retrieve the transactions for

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of transactions per page. Default is 30

\n","type":"text/plain"},"key":"size","value":"30"}],"variable":[]}},"response":[{"id":"cb1ae372-9386-482d-1393-59fffa3ac977","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":{"raw":"{{host}}/api/fm/v1/cards/1/transactions.json?page=1&size=30","host":["{{host}}"],"path":["api","fm","v1","cards","1","transactions.json"],"query":[{"key":"page","value":"1","description":"Defines the page to retrieve the transactions for"},{"key":"size","value":"30","description":"Number of transactions per page. Default is 30"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"3c14351b87d54a17aede40a0d36347ed\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=UG5PUnVLYnpqa0dNZm1LZy9pelJhTjh4RWowekFQa2RQNmwrMHozSVI3VXNLZzNzbDBGaUxOQlNvUUlkc0RPSTR0d3N1eFdxR1pPNUszRFM5NmE5dUJJdDNuMXlHeGVqM2NCRVZQMGVSbStpZFdtbm5rblg1Uk5hMTM0RmZzZmgxY0VzRjEzVjZaN0tWdlVhNVRyQlFqYUs4MXVTWXAzUVBDSEhUaGw2cVFjPS0tSFRzTVRsbCs2ZzV4MVpiWmIwakdRdz09--b33089ed763ec29eb61c65e7b2e0af828947c3c3; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"c5b85aee-9b13-4669-91cb-1bff71da3312","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.477254","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"UG5PUnVLYnpqa0dNZm1LZy9pelJhTjh4RWowekFQa2RQNmwrMHozSVI3VXNLZzNzbDBGaUxOQlNvUUlkc0RPSTR0d3N1eFdxR1pPNUszRFM5NmE5dUJJdDNuMXlHeGVqM2NCRVZQMGVSbStpZFdtbm5rblg1Uk5hMTM0RmZzZmgxY0VzRjEzVjZaN0tWdlVhNVRyQlFqYUs4MXVTWXAzUVBDSEhUaGw2cVFjPS0tSFRzTVRsbCs2ZzV4MVpiWmIwakdRdz09--b33089ed763ec29eb61c65e7b2e0af828947c3c3","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"8f83bb9187c6f706e1083d3647adf798","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"2097a17c95d0b04aa3c8dce60bd7a62f","key":"refresh_token"}],"responseTime":"501","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n },\n \"transactions\": [\n {\n \"id\": 9,\n \"transaction_type\": \"Debit\",\n \"merchant_name\": \"Airtel India\",\n \"reference_id\": \"321744RUPP00035088860006896462\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"POS\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-05-17T03:58:28.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": false,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Suraj Joshi\",\n \"email\": \"suraj@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 400,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 400,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n },\n {\n \"id\": 1,\n \"transaction_type\": \"Debit\",\n \"merchant_name\": \"Callisto\",\n \"reference_id\": \"321744RUPP00035088860001971061\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"Ecom\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-05-08T15:17:15.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": false,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Suraj Joshi\",\n \"email\": \"suraj@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 150,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 150,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n },\n {\n \"id\": 85,\n \"transaction_type\": \"Credit\",\n \"merchant_name\": \"Refund West White\",\n \"reference_id\": \"321744RUPP00035088860001712680\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"null\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-04-26T02:01:32.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": true,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Rajesh Kumar\",\n \"email\": \"rajesh@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 153,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 153,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n },\n {\n \"id\": 5,\n \"transaction_type\": \"Debit\",\n \"merchant_name\": \"Dione\",\n \"reference_id\": \"321744RUPP00035088860003537899\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"POS\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-04-20T18:28:36.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": false,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Suraj Joshi\",\n \"email\": \"suraj@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 135.1234,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 144.1234,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n }\n ]\n}"}],"_postman_id":"96350602-b6a0-fc89-8197-3a4d9031a1f4"},{"name":"Block / Unbock","id":"e8cf91d1-d05a-c7dc-35d2-258a8e3a0cf3","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": 1,\n \"reason\":\"Why am I blocking this\"\n}"},"url":"{{host}}/api/fm/v1/cards/1/status.json","description":"

This API can Block and Unblock a card

\n
\n

Status

\n
    \n
  • Block - 1
    • \n
  • Unblock - 2
    • \n
\n","urlObject":{"path":["api","fm","v1","cards","1","status.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"d87c3d22-3b8d-6639-950f-f06c457fad70","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": 0,\n \"reason\":\"Blocking as I am not finding the card\"\n}"},"url":"{{host}}/api/fm/v1/cards/1/status.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"7d6ee550172ac4f51acc3e0c24941fac\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=Ly9Pb3dObVJVcVJ1OHNKQmtHcG82c0FJK2htZkxmODJqM3paM2V0MC9HeGdOUG13Z1d0d1JCb2J0YVg4UGUxc092ZU5Fd1kzUXk2SlY3eHZldG9RdWMxYjBGdXZMTU9qRlVDS09YSENBUFovei9XNEhrS2dpTk85Wmg0OGpoMkotLTBSZ0NDUjhOVkdwcldOQmx3VnFZN3c9PQ%3D%3D--adf2640415a7495bf4a19670eb86905f096d4535; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"48ae106f-fcb4-44a7-958d-c2f02f40163a","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"1.912743","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"Ly9Pb3dObVJVcVJ1OHNKQmtHcG82c0FJK2htZkxmODJqM3paM2V0MC9HeGdOUG13Z1d0d1JCb2J0YVg4UGUxc092ZU5Fd1kzUXk2SlY3eHZldG9RdWMxYjBGdXZMTU9qRlVDS09YSENBUFovei9XNEhrS2dpTk85Wmg0OGpoMkotLTBSZ0NDUjhOVkdwcldOQmx3VnFZN3c9PQ%3D%3D--adf2640415a7495bf4a19670eb86905f096d4535","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"1931","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [\n \"Successfully blocked the card\"\n ],\n \"message\": [],\n \"notice\": []\n }\n}"}],"_postman_id":"e8cf91d1-d05a-c7dc-35d2-258a8e3a0cf3"},{"name":"Assign Cards","id":"998feb43-d4cf-a865-8b57-35a699358352","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"vivek.a@finly.io\",\n \"card_proxy\":\"S00017740090\",\n \"card_program\":\"expense\"\n}"},"url":"{{host}}/api/fm/v1/cards/assign.json","description":"

Used for assigning cards to users. Card cannot be unassigned once assigned to a user

\n

Card can be assigned using registered email / mobile number

\n","urlObject":{"path":["api","fm","v1","cards","assign.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"998feb43-d4cf-a865-8b57-35a699358352"},{"name":"Request New Cards","id":"49ac4986-ad9c-5270-7678-5adadfb70351","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"update_type\":\"request_cards\",\n \"number\": 5,\n \"type\": 1,\n \"delivery_address\":\"Delivery Address for the cards\"\n}"},"url":"{{host}}/api/cards/v1/cards.json","description":"

This API can be used for placing a request for cards

\n","urlObject":{"path":["api","cards","v1","cards.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49ac4986-ad9c-5270-7678-5adadfb70351"},{"name":"Configure Restrictions","id":"f24ded9b-d2e0-23e1-b90d-3a2fc7207c2a","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"update_type\": \"restrictions\",\n \"atm\": true,\n \"pos\": true,\n \"mcc\": {\n \"type\": 1,\n \"code\": 1\n },\n \"end_date\": \"17-10-2018\",\n \"budget\": {\n \"atm\": {\n \"daily\": 100,\n \"weekly\": 1000,\n \"monthly\": 5000 \n },\n \"pos\": {\n \"daily\": 100,\n \"weekly\": 1000,\n \"monthly\": 5000\n }\n },\n \"transactions\": {\n \"atm\": {\n \"daily\": 2,\n \"weekly\": 3,\n \"monthly\": 8 \n },\n \"pos\": {\n \"daily\": 1,\n \"weekly\": 5,\n \"monthly\": 10\n }\n }\n}"},"url":"{{host}}/api/cards/v1/cards/{{card_id}}.json","description":"

This updates the restrictions set on the card

\n
\n

Types of restrictions

\n
    \n
  • Budget - Sets the maximum budget that can be spent on the card. Amount that can be spent on ATM and POS can be configured separately
    • \n
  • Transactions - Sets the maximum number of transactions that can be done using the card. Number of transactions for ATM and POS can be configured separately
    • \n
  • allow_atm: Setting this as false disables the card from being used in ATMs
    • \n
  • allow_pos: Setting this is false disables the card from being used in online portals / POS
    • \n
  • end_date: Setting an end date for the card, disables the card from being used from the configured date
    • \n
  • mcc: This allows configuration for the card to be blocked or to limit to specified merchant categories.
    • \n
    • \n
    • Type
      • \n
    \n
    • \n
    • \n
      • \n
      • Block - 1
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Unblock - 2
        • \n
      \n
      • \n
    \n
    • \n
    • \n
    • Merchant Category Codes
      • \n
    \n
    • \n
    • \n
      • \n
      • Alcohol - 1
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Electronics - 2
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Entertainment - 3
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Fuel - 4
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Grocery - 5
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Hardware - 6
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Healthcare - 7
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Hotel - 8
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Logistrics - 9
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Meal - 10
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Metro - 11
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Mobile Recharge - 12
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Pharmacy - 13
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Retail - 14
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Transport - 15
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Travel - 16
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Utility - 17
        • \n
      \n
      • \n
    \n
    • \n
    • \n
      • \n
      • Ground Transport - 18
        • \n
      \n
      • \n
    \n
    • \n
\n","urlObject":{"path":["api","cards","v1","cards","{{card_id}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f24ded9b-d2e0-23e1-b90d-3a2fc7207c2a"},{"name":"Auto Reload","id":"1eab3680-7c06-013e-670e-18ee1e6696a9","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enabled\": true,\n \"source_account_type\": \"finly_money\",\n \"source_account_id\":\"1\",\n \"target_balance\": 15000,\n \"threshold_balance\": 5000\n}"},"url":"{{host}}/api/fm/v1/funds/cards/{{card_serial_id}}//autoreload.json","description":"

This API can Credit funds to Finly Money And Card

\n","urlObject":{"path":["api","fm","v1","funds","cards","{{card_serial_id}}","","autoreload.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"40d84949-1a80-d19d-0de9-714b45936582","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 450,\n \"initiating_account\": \"finly_money\",\n \"initiating_account_id\": \"1\",\n \"receiving_account\": \"card\",\n \"receiving_account_id\": \"S00093020032\"\n}"},"url":"{{host}}/api/fm/v1/funds/credit.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"ETag","value":"W/\"98a1b4c75a082cc254a05d578ecde4e6\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Set-Cookie","value":"_Finly_session=TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78; path=/; HttpOnly","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":"Custom header"},{"key":"X-Request-Id","value":"7b54b03b-d806-4835-a35d-504c1a7c0f92","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"41.665027","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"41687","body":"{\"success\":true,\"messages\":{\"error\":[],\"failure\":[],\"success\":[],\"message\":[],\"notice\":[]}}"}],"_postman_id":"1eab3680-7c06-013e-670e-18ee1e6696a9"}],"id":"67055cdd-bd99-dfcd-f10b-a1199106396b","_postman_id":"67055cdd-bd99-dfcd-f10b-a1199106396b","description":""},{"name":"Finly Money","item":[{"name":"Show","id":"1e0b317b-44f4-4f13-f6b4-89f619f1d444","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/finly_money/{{finly_money_id}}.json","description":"

This API retrieves a particular Finly Money Information.

\n
\n

Response contains the follow details

\n
    \n
  • Finly Money Balance - Current Balance of the Finly Money
    • \n
  • Finly Money User
    • \n
\n","urlObject":{"path":["api","fm","v1","finly_money","{{finly_money_id}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"5ab6b691-b867-2e90-dddf-c1ec3cf19201","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/cards/1.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"dc35fcddf4683aa9826e6a8a5c68c99b\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=NkpraVZrbkkrYVF6SzRNSDN5MHUxT2JTYjZGazZnU1RUelUyOEVDeVFpTzBkckZyYXArZzcyaldiM25tc1FhV0tpaENQcTBLM2pNQVNXNFhYVUdHVEpoTjdEZ21YVGZMSUVOUGdsNGpCdVFYZEFXeDRXWnJTeEZYODFFdDhzUlItLTNMSStrT3YxL2VyeEJOTFRHekswN0E9PQ%3D%3D--c6cf2f6cce96a7e558ed966d35a4a777c3624825; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"0e302f6f-ebac-4007-aae7-2c1bb4edc72d","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.357734","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"NkpraVZrbkkrYVF6SzRNSDN5MHUxT2JTYjZGazZnU1RUelUyOEVDeVFpTzBkckZyYXArZzcyaldiM25tc1FhV0tpaENQcTBLM2pNQVNXNFhYVUdHVEpoTjdEZ21YVGZMSUVOUGdsNGpCdVFYZEFXeDRXWnJTeEZYODFFdDhzUlItLTNMSStrT3YxL2VyeEJOTFRHekswN0E9PQ%3D%3D--c6cf2f6cce96a7e558ed966d35a4a777c3624825","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"8f83bb9187c6f706e1083d3647adf798","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"2097a17c95d0b04aa3c8dce60bd7a62f","key":"refresh_token"}],"responseTime":"361","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n },\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"active\": true,\n \"ending_number\": \"7974\",\n \"description\": \"Used for sales and marketing\",\n \"balance\": {\n \"value\": \"5190.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"eligibility\": {\n \"value\": \"4810.0\",\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"disabled_by\": null,\n \"assigned\": true,\n \"assigned_to_user\": {\n \"id\": 1,\n \"name\": \"Rajesh Kumar\",\n \"mobile_number\": \"8099498652\",\n \"email\": \"admin@finlytest.io\"\n },\n \"configurable_restrictions\": true,\n \"restrictions\": {\n \"channel_atm\": true,\n \"channel_ecom_pos\": true,\n \"mcc_group_id\": null,\n \"mcc_restriction_type\": null,\n \"limits\": {\n \"atm_limits\": [\n {\n \"id\": 4,\n \"period_id\": 1,\n \"period_name\": \"day\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 5,\n \"period_id\": 2,\n \"period_name\": \"week\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 6,\n \"period_id\": 3,\n \"period_name\": \"month\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n }\n ],\n \"ecom_pos_limits\": [\n {\n \"id\": 1,\n \"period_id\": 1,\n \"period_name\": \"day\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 2,\n \"period_id\": 2,\n \"period_name\": \"week\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n },\n {\n \"id\": 3,\n \"period_id\": 3,\n \"period_name\": \"month\",\n \"budget\": null,\n \"transactions\": null,\n \"enabled\": null\n }\n ]\n }\n }\n}"}],"_postman_id":"1e0b317b-44f4-4f13-f6b4-89f619f1d444"},{"name":"Transactions","id":"1966af07-2d6a-f3d8-5818-0e20f44f6a62","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":"{{host}}/api/fm/v1/finly_money/{{finly_money_id}}/transactions.json?page=1&size=30","description":"

This API retrieves the Finly Money transactions

\n
\n

Params

\n
    \n
  • size - Number of transactions per page. Default is 30
    • \n
  • page - Defines the page to retrieve the transactions for
    • \n
\n","urlObject":{"path":["api","fm","v1","finly_money","{{finly_money_id}}","transactions.json"],"host":["{{host}}"],"query":[{"description":{"content":"

Defines the page to retrieve the transactions for

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of transactions per page. Default is 30

\n","type":"text/plain"},"key":"size","value":"30"}],"variable":[]}},"response":[{"id":"c4031633-afd6-83ae-0dec-f0ec57bb6a47","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Yolo\"\n}"},"url":{"raw":"{{host}}/api/fm/v1/cards/1/transactions.json?page=1&size=30","host":["{{host}}"],"path":["api","fm","v1","cards","1","transactions.json"],"query":[{"key":"page","value":"1","description":"Defines the page to retrieve the transactions for"},{"key":"size","value":"30","description":"Number of transactions per page. Default is 30"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"3c14351b87d54a17aede40a0d36347ed\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=UG5PUnVLYnpqa0dNZm1LZy9pelJhTjh4RWowekFQa2RQNmwrMHozSVI3VXNLZzNzbDBGaUxOQlNvUUlkc0RPSTR0d3N1eFdxR1pPNUszRFM5NmE5dUJJdDNuMXlHeGVqM2NCRVZQMGVSbStpZFdtbm5rblg1Uk5hMTM0RmZzZmgxY0VzRjEzVjZaN0tWdlVhNVRyQlFqYUs4MXVTWXAzUVBDSEhUaGw2cVFjPS0tSFRzTVRsbCs2ZzV4MVpiWmIwakdRdz09--b33089ed763ec29eb61c65e7b2e0af828947c3c3; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"c5b85aee-9b13-4669-91cb-1bff71da3312","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"0.477254","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"UG5PUnVLYnpqa0dNZm1LZy9pelJhTjh4RWowekFQa2RQNmwrMHozSVI3VXNLZzNzbDBGaUxOQlNvUUlkc0RPSTR0d3N1eFdxR1pPNUszRFM5NmE5dUJJdDNuMXlHeGVqM2NCRVZQMGVSbStpZFdtbm5rblg1Uk5hMTM0RmZzZmgxY0VzRjEzVjZaN0tWdlVhNVRyQlFqYUs4MXVTWXAzUVBDSEhUaGw2cVFjPS0tSFRzTVRsbCs2ZzV4MVpiWmIwakdRdz09--b33089ed763ec29eb61c65e7b2e0af828947c3c3","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"8f83bb9187c6f706e1083d3647adf798","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"2097a17c95d0b04aa3c8dce60bd7a62f","key":"refresh_token"}],"responseTime":"501","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n },\n \"transactions\": [\n {\n \"id\": 9,\n \"transaction_type\": \"Debit\",\n \"merchant_name\": \"Airtel India\",\n \"reference_id\": \"321744RUPP00035088860006896462\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"POS\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-05-17T03:58:28.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": false,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Suraj Joshi\",\n \"email\": \"suraj@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 400,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 400,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n },\n {\n \"id\": 1,\n \"transaction_type\": \"Debit\",\n \"merchant_name\": \"Callisto\",\n \"reference_id\": \"321744RUPP00035088860001971061\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"Ecom\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-05-08T15:17:15.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": false,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Suraj Joshi\",\n \"email\": \"suraj@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 150,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 150,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n },\n {\n \"id\": 85,\n \"transaction_type\": \"Credit\",\n \"merchant_name\": \"Refund West White\",\n \"reference_id\": \"321744RUPP00035088860001712680\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"null\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-04-26T02:01:32.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": true,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Rajesh Kumar\",\n \"email\": \"rajesh@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 153,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 153,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n },\n {\n \"id\": 5,\n \"transaction_type\": \"Debit\",\n \"merchant_name\": \"Dione\",\n \"reference_id\": \"321744RUPP00035088860003537899\",\n \"auth_transaction_id\": \"173244\",\n \"transaction_mode\": \"POS\",\n \"response_code\": \"00\",\n \"transaction_timestamp\": \"2017-04-20T18:28:36.000+05:30\",\n \"mcc_code\": null,\n \"transaction_status\": null,\n \"api_reference_id\": null,\n \"cancelled\": false,\n \"type_of_details\": null,\n \"user\": {\n \"id\": 1,\n \"name\": \"Suraj Joshi\",\n \"email\": \"suraj@companyx.com\",\n \"mobile_number\": \"8099498652\"\n },\n \"card\": {\n \"id\": 1,\n \"serial_id\": \"S00017740090\",\n \"ending_number\": \"7974\"\n },\n \"transaction_amount\": {\n \"value\": 135.1234,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"billing_amount\": {\n \"value\": 144.1234,\n \"currency\": {\n \"id\": 1,\n \"country\": \"India Rupee\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n },\n \"merchant_key\": \"OLCDCB_POSOFFUS\",\n \"merchant_city\": null\n }\n ]\n}"}],"_postman_id":"1966af07-2d6a-f3d8-5818-0e20f44f6a62"}],"id":"813059d9-c7f1-2471-9fcf-cac7726f7a21","_postman_id":"813059d9-c7f1-2471-9fcf-cac7726f7a21","description":""}],"id":"bd87665e-7115-502d-09e8-138781336a48","_postman_id":"bd87665e-7115-502d-09e8-138781336a48","description":""},{"name":"Bank Transfer","item":[{"name":"Payment Order","item":[{"name":"Create","id":"12e43bcf-fb2c-12d0-2359-c32500d120a6","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"transfer_type\":\"neft\", \n\t\"policy_id\":\"4\", \n\t\"initating_account_type\":\"2\", \n\t\"account_owner_type\":\"2\", \n\t\"scheduled_at\":\"14 Mar 2018\", \n\t\"description\":\"This is a test payment order\", \n\t\"debit_account_number\": \"XXXXXXXXXXXXXXX\",\n\t\"payment_order\": {\n\t\t\"0\":{\n\t\t\t\"account_id\":\"3\", \n\t\t\t\"owner_name\":\"Office Stationary Abinash\", \n\t\t\t\"name\":\"SBI HAL Ac\", \n\t\t\t\"bank_account_number\":\"34968635304\", \n\t\t\t\"ifsc\":\"SBIN0001114\", \n\t\t\t\"invoice_number\":\"INV908980\", \n\t\t\t\"invoice_date\":\"01 Mar 2018\", \n\t\t\t\"due_date\":\"28 Mar 2018\",\n\t\t\t\"note\":\"Test note\", \n\t\t\t\"original_amount\":\"340\", \n\t\t\t\"currency_id\":\"1\", \n\t\t\t\"tds_slab_id\":\"0\", \n\t\t\t\"advance_amount\":\"0\", \n\t\t\t\"freight\":\"0.00\", \n\t\t\t\"roundoff_amount\":\"-0.48\", \n\t\t\t\"gst_type_id\":\"1\", \n\t\t\t\"invoice_attachment_ids\": 348,\n\t\t\t\"external_reference_id\": \"123123123\",\n\t\t\t\"custom_fields\": {\n\t\t\t\t\"{{Custom Field ID}}\": \"{{Custom Field Value}}\"\n\t\t\t},\n\t\t\t\"invoice_attributes\":{\n\t\t\t\t\"invoice_items_attributes\":[\n\t\t\t\t\t{\n\t\t\t\t\t\t\"description\":\"HB Pencils\", \n\t\t\t\t\t\t\"category_id\":\"1006\", \n\t\t\t\t\t\t\"hsn_sac\":\"HSN\", \n\t\t\t\t\t\t\"quantity\":\"2\", \n\t\t\t\t\t\t\"rate\":\"20\", \n\t\t\t\t\t\t\"discount\":\"15\",\n\t\t\t\t\t\t\"tax\":\"18\"\n\t\t\t\t\t}, \n\t\t\t\t\t{\n\t\t\t\t\t\t\"description\":\"Toyota Camry\", \n\t\t\t\t\t\t\"category_id\":\"1005\", \n\t\t\t\t\t\t\"hsn_sac\":\"SAC\", \n\t\t\t\t\t\t\"quantity\":\"10\", \n\t\t\t\t\t\t\"rate\":\"30000\", \n\t\t\t\t\t\t\"amount\":\"300\", \n\t\t\t\t\t\t\"discount\":\"16\", \n\t\t\t\t\t\t\"tax\":\"18\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t\"2\":{\n\t\t\t\t\"account_id\":\"7\", \n\t\t\t\t\"owner_name\":\"Sangam International\", \n\t\t\t\t\"name\":\"Sangam International\", \n\t\t\t\t\"bank_account_number\":\"50200012257549\", \n\t\t\t\t\"ifsc\":\"HDFC0004228\", \n\t\t\t\t\"invoice_number\":\"OLACABS\", \n\t\t\t\t\"invoice_date\":\"07 Mar 2018\", \n\t\t\t\t\"due_date\":\"28 Mar 2018\",\n\t\t\t\t\"note\":\"asdvasdv\", \n\t\t\t\t\"original_amount\":\"2000\", \n\t\t\t\t\"currency_id\":\"1\", \n\t\t\t\t\"discount\":\"12\", \n\t\t\t\t\"gst_type_id\":\"1\", \n\t\t\t\t\"tax\":\"15\", \n\t\t\t\t\"tds_slab_id\":\"0\", \n\t\t\t\t\"freight\":\"0.00\",\n\t\t\t\t\"advance_amount\": \"0.00\",\n\t\t\t\t\"roundoff_amount\":\"0.00\",\n\t\t\t\t\"invoice_attachment_ids\": 350,\n\t\t\t\t\"external_reference_id\": \"123123124\",\n\t\t\t\t\"custom_fields\": {\n\t\t\t\t\t\"{{Custom Field ID}}\": \"{{Custom Field Value}}\"\n\t\t\t}\n\t\t}\n\t\t\n\t}, \n\t\"view\":\"initiator\"\n}"},"url":"{{host}}/api/vp/bank_transfer/bank_payment_requests.json","description":"

This API will create a payment order in Finly. A Payment Order is a collection of payments that can can go through an approval process (defined through the Finly dashboard)

\n

Parameters (ones marked with * are compulsory :

\n
    \n
  • transfer_type*: The mode of transfer for all payments in this payment order. Can be NEFT/IMPS/RTGS
    • \n
  • policy_id*: The policy with which this particular payment order will be created and processed. Different policies allow for different approval flows within your company
    • \n
  • initiating_account_type*: 2 by default for all payments to vendors
    • \n
  • account_owner_type*: 2 by default for all payments to vendors
    • \n
  • scheduled_at*: Schedule date for which this particular order needs to be processed
    • \n
  • description: Optional description for payment order
    • \n
  • debit_account_number: In case multiple bank accounts are connected, enter the account number of the source account here. If nothing is entered, the default configured account number will be chosen.
    • \n
\n

Within payment_order, the below are the attributes for each individual payment:

\n

In case the beneficiary bank account id is already known:

\n
    \n
  • account_id: This parameter will be used if the beneficiary bank account id is already known and the payment will be directly associated with this beneficiary
    • \n
\n

In case the beneficiary bank account is is not known and the payment is being made directly to a new beneficiary

\n
    \n
  • owner_name*: Name of the beneficiary
    • \n
  • name*: Name of the bank account (can be same as above)
    • \n
  • bank_account_number*: Account number of beneficiary bank account
    • \n
  • ifsc*: IFSC of the beneficiary bank account
    • \n
\n

The below details are the other parameters associated with a particular payment

\n
    \n
  • invoice_number: If the paymnet is being made against an invoice, the invoice numbert
    • \n
  • invoice_date: Date on which the invoice was created
    • \n
  • due_date: Due date of the invoice
    • \n
  • note: Optional note
    • \n
  • original_amount*: Raw amount of an invoice - simply the total of the base value of all items in the invoice
    • \n
  • tds_slab_id: ID of the TDS slab that is applicable for this invoice. The list of all TDS slabs for your company can be found in the \"TDS Slabs\" folder Index API
    • \n
  • freight: Freight amount for the Invoice (if any) against which this payment is being made
    • \n
  • roundoff_amount: Round off amount for this particular invoice
    • \n
  • gst_type_id: The type of GST applicable foir this particular invoice (1 - IGST, 2 - SGST + CGST)
    • \n
  • invoice_attachment_ids: IDs of the invoice attachments that are being attached to the this invoice (for now, restricted to 1)
    • \n
  • tax: If there are not invoice line items, the overall tax on the invoice (if there ARE line items, the individual taxes will be sent separately)
    • \n
  • discount: If there are no invoice line items, the overall discount on the invoice (if there ARE line items, the individual taxes will be sent separately)
    • \n
  • external_reference_id: Unique reference ID generated from the client's end for their record-keeping. If entered, this will check against previous records to see if any other payment belonging to this particular client contains the same ID - and will prevent creation of duplicate records with the same external reference ID
    • \n
\n

Custom Fields for an Invoice

\n
    \n
  • Custom Field ID: ID of the custom field for this particular object
    • \n
  • Custom Field Value: Value of the custom field. This will be based on the type of custom field they contain: For text it will be a plain text value, for drop downs it will be the id of the drop down element etc.
    • \n
\n

Within invoice_items_attributes, the below are the attributes for each individual item that is part of the invoice (if any). This block can be skipped if there is no invoice associated with this payment

\n
    \n
  • description : Description of the item
    • \n
  • category_id : Category ID of this particular Invoice Item
    • \n
  • hsn_sac : HSN or SAC number of this invoice item
    • \n
  • quantity*: Quantity of items being bought as part of this invoice
    • \n
  • rate*: Rate of the item being bought as part of this invoice
    • \n
  • discount: Discount rate for this particular item
    • \n
  • tax: Tax rate for this particular item
    • \n
\n","urlObject":{"path":["api","vp","bank_transfer","bank_payment_requests.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12e43bcf-fb2c-12d0-2359-c32500d120a6"},{"name":"Show","id":"fd9868d8-febc-757c-4174-7cbeabc2d974","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/api/vp/bank_transfer/bank_payment_requests/{{id}}.json","urlObject":{"path":["api","vp","bank_transfer","bank_payment_requests","{{id}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd9868d8-febc-757c-4174-7cbeabc2d974"},{"name":"Credit","id":"6cbbd6ac-8a7f-3a6d-9ca2-d0751afed4e1","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"password\": \"demo1234\",\n\t\"initiating_account_type\": \"1\",\n\t\"view\": \"initiator\"\n}"},"url":"{{host}}/api/vp/bank_transfer/bank_payment_requests/{{id}}/credit.json","description":"

id is the ID of the payment order that you wish to credit

\n
    \n
  • password: You account password used during login
    • \n
  • initiating_account_type: Defaults to '1' which selects your company credits as the source account for this payment
    • \n
\n","urlObject":{"path":["api","vp","bank_transfer","bank_payment_requests","{{id}}","credit.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cbbd6ac-8a7f-3a6d-9ca2-d0751afed4e1"}],"id":"5dfc2a88-003e-b1a5-0af8-f2720dbe0ae6","_postman_id":"5dfc2a88-003e-b1a5-0af8-f2720dbe0ae6","description":""},{"name":"Vendor","item":[{"name":"Create","id":"6353b0de-ec8b-4e9e-ba60-4148fe5460d6","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"vendor\":{\n\t\t\"name\": \"Vendor full name\",\n\t\t\"email\": \"vendor@email.com\",\n\t\t\"mobile_number\": \"9980098923\",\n\t\t\"authorized\": true,\n\t\t\"description\": \"Vendor description\",\n\t\t\"pan\": \"PANNUMBER\",\n\t\t\"tin\": \"TINNUMBER\",\n\t\t\"gst_registered\": true,\n\t\t\"gst\": \"GSTIN\",\n\t\t\"state_code_id\": 1,\n\t\t\"bank_accounts_attributes\": [\n\t\t\t{\n\t\t\t\t\"name\": \"HDFC Bank\",\n\t\t\t\t\"account_number\": \"502918273910231213\", \n\t\t\t\t\"ifsc\": \"YESB0CMSNOC\", \n\t\t\t\t\"default_account\": true\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"Yes Bank\",\n\t\t\t\t\"account_number\": \"502918273910209123\", \n\t\t\t\t\"ifsc\": \"YESB0CMSNOC\", \n\t\t\t\t\"default_account\": false\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"{{host}}/api/vp/vendors.json","description":"

This API is used for creating vendors

\n","urlObject":{"path":["api","vp","vendors.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b1de6e1d-90b8-4899-be98-c51b08f67706","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": 20000,\n\t\"name\": \"Ram's HDFC Bank\",\n\t\"account_number\":\"01982309128309128\",\n\t\"ifsc\": \"HDFC1092\",\n\t\"mode\": \"neft\",\n\t\"scheduled_at\":\"15-05-2017\"\n}"},"url":"{{host}}/api/vp/v1/bank_transfers/initiate.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"98a1b4c75a082cc254a05d578ecde4e6\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"7b54b03b-d806-4835-a35d-504c1a7c0f92","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"41.665027","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78","key":"_Finly_session"},{"expires":"Invalid Date","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Invalid Date","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":null,"body":"{\"success\":true,\"messages\":{\"error\":[],\"failure\":[],\"success\":[],\"message\":[],\"notice\":[]}}"}],"_postman_id":"6353b0de-ec8b-4e9e-ba60-4148fe5460d6"}],"id":"37f144ca-6306-427c-9860-f9f058ba784c","_postman_id":"37f144ca-6306-427c-9860-f9f058ba784c","description":""},{"name":"Inward Invoice Attachments","item":[{"name":"Index","id":"ed8feb2f-c04a-5054-cd2c-98dfb0693018","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/api/vp/v1/inward_invoice_attachments.json","description":"

This API will return all invoice attachments that belong to a company that aren't already associated with an invoice.

\n","urlObject":{"path":["api","vp","v1","inward_invoice_attachments.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed8feb2f-c04a-5054-cd2c-98dfb0693018"},{"name":"Create","id":"46795578-9883-0d62-2bec-d4c5a746ce79","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[{"key":"invoice_attachment[attached_file]","value":null,"type":"file"},{"key":"invoice_attachment[description]","value":"Some description","type":"text"}]},"url":"{{host}}/api/vp/v1/inward_invoice_attachments.json","description":"

This API will create an inward invoice attachment in Finly and return the id of the same, which can then be associated with an inward invoice.

\n

Parameters:

\n
    \n
  • attached_file: The actual file that will be uploaded
    • \n
  • description: Optional description for this particular attachment
    • \n
\n","urlObject":{"path":["api","vp","v1","inward_invoice_attachments.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"46795578-9883-0d62-2bec-d4c5a746ce79"}],"id":"5fe79db6-409f-5f7a-a8e7-f043b081a305","_postman_id":"5fe79db6-409f-5f7a-a8e7-f043b081a305","description":""},{"name":"TDS Slabs","item":[{"name":"Index","id":"775194c9-4fc6-1d89-e03a-80ba5fc2a958","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/tds_slabs.json","urlObject":{"path":["tds_slabs.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"775194c9-4fc6-1d89-e03a-80ba5fc2a958"}],"id":"e2533567-d778-57f8-a07d-4a358593692c","_postman_id":"e2533567-d778-57f8-a07d-4a358593692c","description":""},{"name":"Bank Account","item":[{"name":"Disable Bank account","id":"0a2b77a4-d4e7-4307-90a7-51ed0e7d2291","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"account_number\": \"XXXXXXXXXXXX\"\n}"},"url":"{{host}}/api/vp/v1/bank_accounts/disable.json","description":"

This API will let you block a particualr bank account from being credited.

\n

Parameters:

\n
    \n
  • account_number: The account number you would like to disable from crediting
    • \n
\n

Please note: If you have multiple accounts using the same account number as above, they will ALL be disabled from being credited

\n","urlObject":{"path":["api","vp","v1","bank_accounts","disable.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a2b77a4-d4e7-4307-90a7-51ed0e7d2291"}],"id":"856fce7f-aa06-4341-a1a3-738f92583b16","_postman_id":"856fce7f-aa06-4341-a1a3-738f92583b16","description":""},{"name":"Index","id":"8afebe88-764a-df83-4868-da60a76ad2f8","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{host}}/api/vp/v1/bank_transfers.json?filter_date[from]=&filter_date[to]=&filter_payment_id=&filter_receiving_user_name=&filter_initiating_user_name=&filter_beneficiary_account_number=&filter_beneficiary_account_ifsc=&filter_api_initiated=false","description":"

This API lists all the initiated through the company payments/transfers

\n

Parameters:

\n
    \n
  • filter_date[from] - Start date in dd-mm-yyyy format
    • \n
  • filter_date[to] - End date in dd-mm-yyyy format
    • \n
  • filter_payment_id - a particular payment ID that you'd like to filter out
    • \n
  • filter_receiving_user_name - filter by name of the receiving user / vendor
    • \n
  • filter_initiating_user_name - filter by name of the initiating user
    • \n
  • filter_beneficiary_account_number - filter by account number of the beneficiary bank account
    • \n
  • filter_beneficiary_account_ifsc - filter by the IFSC of the beneficiary bank account
    • \n
  • filter_api_initiated - if true only payments initiated via API are returned, if false only payments from dashboard, if nothing is passed, it returns all payments
    • \n
\n

Pagination Parameters:

\n
    \n
  • page - The page number for the list of payments that you want to view
    • \n
  • per_page - Number of payments per page that will be shown per page. Defaults to 30 if nothing is passed
    • \n
\n","urlObject":{"path":["api","vp","v1","bank_transfers.json"],"host":["{{host}}"],"query":[{"key":"filter_date[from]","value":""},{"key":"filter_date[to]","value":""},{"key":"filter_payment_id","value":""},{"key":"filter_receiving_user_name","value":""},{"key":"filter_initiating_user_name","value":""},{"key":"filter_beneficiary_account_number","value":""},{"key":"filter_beneficiary_account_ifsc","value":""},{"disabled":true,"key":"per_page","value":"30"},{"disabled":true,"key":"page","value":"10"},{"key":"filter_api_initiated","value":"false"}],"variable":[]}},"response":[{"id":"468e8977-7df1-8ae4-268a-55d7af6cdd84","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{host}}/api/vp/v1/bank_transfers.json?from=10-05-2017&to=20-05-2017","host":["{{host}}"],"path":["api","vp","v1","bank_transfers.json"],"query":[{"key":"from","value":"10-05-2017"},{"key":"to","value":"20-05-2017"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"98a1b4c75a082cc254a05d578ecde4e6\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"7b54b03b-d806-4835-a35d-504c1a7c0f92","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"41.665027","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"41687","body":"[\n {\n \"id\": 1598,\n \"beneficiary\": {\n \"name\": \"Sample Vendor\",\n \"account_number\": \"56123546216525\",\n \"ifsc\": \"IFSC1231231\"\n },\n \"date\": \"2019-03-27\",\n \"payment_mode\": \"NEFT\",\n \"schedule_at\": null,\n \"processed_at\": null,\n \"status\": \"pending approval\",\n \"amount\": \"130.0\",\n \"initiated_by\": \"Nikhil M\",\n \"utr\": null,\n \"bank_payment_request_id\": 1527,\n \"payment_order_id\": 1527,\n \"api_initiated\": null,\n \"custom_fields\": [\n {\n \"name\": \"Cost Head\",\n \"value\": \"Operations\"\n },\n {\n \"name\": \"Cost Month\",\n \"value\": \"Feb\"\n }\n ],\n \"invoice_date\": null,\n \"credited_date\": null,\n \"invoice\": {\n \"tds\": \"12.0\",\n \"tax\": \"21.6\",\n \"net_amount\": \"130.0\"\n }\n }\n]"},{"id":"f9dda3e7-a416-456c-ac54-432cbcecea30","name":"Index","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","disabled":true}],"url":{"raw":"{{host}}/api/vp/v1/bank_transfers.json?filter_date[from]=&filter_date[to]=&filter_payment_id=1598&filter_receiving_user_name=&filter_initiating_user_name=&filter_beneficiary_account_number=&filter_beneficiary_account_ifsc=","host":["{{host}}"],"path":["api","vp","v1","bank_transfers.json"],"query":[{"key":"filter_date[from]","value":""},{"key":"filter_date[to]","value":""},{"key":"filter_payment_id","value":"1598"},{"key":"filter_receiving_user_name","value":""},{"key":"filter_initiating_user_name","value":""},{"key":"filter_beneficiary_account_number","value":""},{"key":"filter_beneficiary_account_ifsc","value":""},{"key":"per_page","value":"30","disabled":true},{"key":"page","value":"10","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.10.2"},{"key":"Date","value":"Wed, 27 Mar 2019 18:55:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"0e3f2feca503dbec54f48db4751ac879\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_Finly_session=OFJGb2pidFVENXc3N0xRRGN0bmRlM0JMM1IyVjZJTVc0aFdQbUpzVENIM1M3YTBGMGE5MmpFSmtjS3VMVVJwR0w5VUtmVEpUVVR0bXhYeTJ1a0dQM3RkRTZ2N0k2MFNmUmNrYi96U3dGQUpWS255dFpHOUtna2dhNE1GMkhRamhEQ0dLSjh1NCtWRzJKRERITVU1ekE5aDVRdWZUUkVzV0NRTXhYaTNQVjJ4RnB4VmVkbkFkSUp2RGRpeWNvVnNSdEtObENCanlyaUFRM1AwZExVTDNpU2hKbmZuakllZTR3ZkxjRFF0Z3JiaTRERFJrYTF5aVl4VnVzbVJkdWprQlB3YlFqc0U1d2ZzaXU2Wks4SUtqbWlncXQ1d3Z0SDYxOFRqVGtpOXVvNmJOTlM5anNHVDBUR3J6aVNPcjZkd0hDM1U5MG5LL1hjZENyN2NxcVZ0cFRjK0s1bitqQmFqUUVDWFpFUzFDdERPWWdCaTNPVnBESFpNYjlJZjd0RmUxWlZlcThPMktHcktFbmkyd25WM3B2L2sxeWlFM1RJR0V2QzZ5OW5hMjZEST0tLUk1UUFxbUJ5eWtCaGFmb2NDQ3ZzRlE9PQ%3D%3D--3e596e23d8b99357c96ddfa1261969af11e13c2d; path=/; HttpOnly"},{"key":"X-Request-Id","value":"20db532c-fd30-406a-9261-1c80f111a9b5"},{"key":"X-Runtime","value":"0.078591"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, OPTIONS"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1598,\n \"beneficiary\": {\n \"name\": \"Sample Vendor\",\n \"account_number\": \"56123546216525\",\n \"ifsc\": \"IFSC1231231\"\n },\n \"date\": \"2019-03-27\",\n \"payment_mode\": \"NEFT\",\n \"schedule_at\": null,\n \"processed_at\": null,\n \"status\": \"pending approval\",\n \"amount\": \"130.0\",\n \"initiated_by\": \"Nikhil M\",\n \"bank_payment_request_id\": 1527,\n \"payment_order_id\": 1527,\n \"api_initiated\": null,\n \"custom_fields\": [\n {\n \"name\": \"Cost Head\",\n \"value\": \"Operations\"\n },\n {\n \"name\": \"Cost Month\",\n \"value\": \"Feb\"\n }\n ],\n \"invoice_date\": null,\n \"credited_date\": null,\n \"invoice\": {\n \"tds\": \"12.0\",\n \"tax\": \"21.6\",\n \"net_amount\": \"130.0\"\n }\n }\n]"}],"_postman_id":"8afebe88-764a-df83-4868-da60a76ad2f8"},{"name":"Balance Check","id":"51f989d3-ec75-8a33-35a7-db7a42694f1f","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{host}}/api/fm/v1/balances.json","description":"

This API retrieves the available balance in your

\n","urlObject":{"path":["api","fm","v1","balances.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"aa301bdd-f680-e3b7-9194-b6d914ff1e2e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{host}}/api/vp/v1/balance.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"ETag","value":"W/\"98a1b4c75a082cc254a05d578ecde4e6\"","name":"ETag","description":""},{"key":"Set-Cookie","value":"_Finly_session=TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78; path=/; HttpOnly","name":"Set-Cookie","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":""},{"key":"X-Meta-Request-Version","value":"0.4.0","name":"X-Meta-Request-Version","description":""},{"key":"X-Request-Id","value":"7b54b03b-d806-4835-a35d-504c1a7c0f92","name":"X-Request-Id","description":""},{"key":"X-Runtime","value":"41.665027","name":"X-Runtime","description":""},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"TFgzR3lnSGE3WGdzdFl1Zm1ZY2pKTGVHejZrSmVzQm9xY0lRa0tHdFRIM1BIQ2JvNTlROVFFMERCdSttbU9xK2Q0ZXgyd1VBZU9Zd2NjL3crclJYTzV2cFRmMGwydzEvZnVRQnhDSnZScVNpdkIxaFpieUcxMVNnWGVpRWdGZTgtLUpqUXg0K21jaEVuRGs4NzBDV2hPTnc9PQ%3D%3D--7155afd7e7ae393e99060860966780a46bdf7d78","key":"_Finly_session"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"89399e352eb9c307a6e8a981527ae654","key":"access_token"},{"expires":"Mon Jan 18 2038 21:44:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"127.0.0.1","path":"/","secure":false,"value":"1e074d6f48d00d3dfa8c3fad839de35c","key":"refresh_token"}],"responseTime":"41687","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n },\n \"balances\": {\n \"company_credits\": [\n {\n \"name\": \"Card Transfer Credits\",\n \"type\": \"card\",\n \"balance\": \"Temporarily unavailable\"\n },\n {\n \"name\": \"Bank Transfer Credits\",\n \"type\": \"bank\",\n \"balance\": \"199999991537.0\"\n }\n ],\n \"finly_money\": [\n {\n \"name\": \"Card Transfer Pocket\",\n \"type\": \"card\",\n \"balance\": \"0.0\"\n },\n {\n \"name\": \"Bank Transfer Pocket\",\n \"type\": \"bank\",\n \"balance\": \"77.0\"\n }\n ],\n \"cards\": [\n {\n \"name\": \"Expense\",\n \"balance\": 0,\n \"eligibility\": 0,\n \"active\": true,\n \"disabler\": \"Veekshith Rai\",\n \"disabler_role\": \"Admin\"\n }\n ],\n \"user_pockets\": [\n {\n \"name\": \"Cash on Hand\",\n \"type\": \"Cash\",\n \"balance\": \"20684.753\",\n \"base_currency\": {\n \"id\": 1,\n \"country\": \"India\",\n \"country_code\": \"INR\",\n \"symbol\": \"₹\"\n }\n }\n ]\n }\n}"}],"_postman_id":"51f989d3-ec75-8a33-35a7-db7a42694f1f"},{"name":"Inititate Payment","id":"465ad108-d0d5-10a2-ec2d-979b9d72a82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Sreeram's SBI account\",\n\t\"account_number\": \"1234123412123\",\n\t\"ifsc\": \"IFSC1234567\",\n\t\"amount\": \"20\",\n\t\"mode\": \"imps\",\n\t\"note\": \"Sample note\",\n\t\"mobile_number\": \"8989787809\",\n\t\"external_reference_id\": \"1111134\",\n\t\"debit_account_number\": \"XXXXXXXXXXXXX\"\n}"},"url":"{{host}}/api/vp/bank_transfer/initiate_payment.json","description":"

This API will initiate a payment to the respective bank account, IFSC combination mentioned in the parameters.

\n
    \n
  • name: Name of the benficiary who will be receiving the payment
    • \n
  • account_number: Account number of the beneficiary
    • \n
  • ifsc: IFSC of beneficiary bank account
    • \n
  • amount: Amount to he transferred to the bank account
    • \n
  • mode: Mode of transfer to bank account (NEFT / IMPS / RTGS)
    • \n
  • note: Optional note accompanying an API payment
    • \n
  • mobile_number: The mpbile number of the beneficiary, who will get an SMS notifying them about the transfer. The SMS is contingent to services offered by the beneficiary bank on the same.
    • \n
  • external_reference_id: (optional) Unique reference ID generated from the client's end for their record-keeping. If entered, this will check against previous records to see if any other payment belonging to this particular client contains the same ID - and will prevent creation of duplicate records with the same external reference ID
    • \n
  • debit_account_number: In case multiple bank accounts are connected, enter the account number of the source account for this transaction. If nothing is entered, the default account number (and hence bank account) will be chosen
    • \n
\n","urlObject":{"path":["api","vp","bank_transfer","initiate_payment.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"186d40ce-f387-4b0d-b569-42e9efb4b312","name":"Inititate Payment - Success Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Test account\",\n\t\"account_number\": \"123412341651\",\n\t\"ifsc\": \"IFSC11223344\",\n\t\"amount\": \"20\",\n\t\"mode\": \"neft\",\n\t\"note\": \"Sample note\",\n\t\"external_reference_id\": \"11116\",\n\t\"debit_account_number\": \"XXXXXXXXXXXXX\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/vp/bank_transfer/initiate_payment.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.10.2"},{"key":"Date","value":"Wed, 30 Oct 2019 03:35:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"X-Request-Id","value":"19310a84-1950-453e-bd55-8ea418ae1056"},{"key":"X-Runtime","value":"0.180525"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"failure\": [],\n \"success\": [\n \"Payment successfully processed. You can check the status in some time\"\n ],\n \"message\": [],\n \"notice\": []\n },\n \"summary\": {\n \"order_status\": {\n \"name\": \"Pending\",\n \"identifier\": \"pending\"\n },\n \"policy\": {\n \"id\": 7,\n \"name\": \"Company (Default)\"\n },\n \"bank_transfer_type\": \"NEFT\",\n \"payment_type\": \"Credit\",\n \"scheduled_at\": null,\n \"processed_at\": null,\n \"amount_requested\": \"20.0\",\n \"amount_processed\": \"0.0\",\n \"description\": null,\n \"note\": null,\n \"initiating_user\": \"Aravind Sanka\",\n \"name\": \"PR_aravind_sanka_30.10.19\"\n },\n \"payments\": [\n {\n \"owner_name\": \"Test account\",\n \"name\": \"Test account\",\n \"account_number\": \"123412341651\",\n \"ifsc\": \"IFSC1122334\",\n \"net_amount\": \"20.0\",\n \"status\": \"Pending\",\n \"id\": 2408,\n \"note\": \"Sample note\",\n \"system_messages\": [],\n \"payment_mode\": \"neft\",\n \"bank_reference_number\": null\n }\n ]\n}"},{"id":"45a987ec-c796-4aff-a970-751db48ead7d","name":"Inititate Payment - Failure (When External ID is already taken)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Test account\",\n\t\"account_number\": \"123412341651\",\n\t\"ifsc\": \"IFSC11223344\",\n\t\"amount\": \"20\",\n\t\"mode\": \"neft\",\n\t\"note\": \"Sample note\",\n\t\"external_reference_id\": \"11116\",\n\t\"debit_account_number\": \"XXXXXXXXXXXXX\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/vp/bank_transfer/initiate_payment.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.10.2"},{"key":"Date","value":"Wed, 30 Oct 2019 03:36:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"X-Request-Id","value":"9dc5c5cc-8308-401c-8c6e-e8cfe241ed6c"},{"key":"X-Runtime","value":"0.053057"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PATCH, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"messages\": {\n \"error\": [\n \"Payment order payments external reference has already been taken\"\n ],\n \"failure\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n }\n}"}],"_postman_id":"465ad108-d0d5-10a2-ec2d-979b9d72a82e"},{"name":"Get Payment Status by external ID","id":"466f31bc-6ee8-0bdf-9cc9-c5a51be1aa89","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{host}}/api/vp/bank_transfer/payment_status_by_external_id/{{external_id}}.json","description":"

This API will take the EXTERNAL ID of a particular payment that was initiated previously and return the status of the payment

\n

-external_id: ID of the payment for which you want to check the status

\n","urlObject":{"path":["api","vp","bank_transfer","payment_status_by_external_id","{{external_id}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"466f31bc-6ee8-0bdf-9cc9-c5a51be1aa89"},{"name":"Bulk Initiate Payment","id":"145e78bb-67db-61b8-7e6c-34f86132c5e1","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"mode\": \"NEFT\",\n\t\"payments\": [\n\t\t{\n\t\t\t\"account_number\": \"30835594365\",\n\t\t\t\"ifsc\": \"SBIN0007990\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\",\n\t\t\t\"external_reference_id\": \"123123124\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"56621232153123\",\n\t\t\t\"ifsc\": \"HDFC00015523\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Second Sample note\",\n\t\t\t\"name\": \"Second bank account\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"611223305\",\n\t\t\t\"ifsc\": \"KKBK0023569\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Third Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"611223305\",\n\t\t\t\"ifsc\": \"KKBK0023569\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Third Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"611223305\",\n\t\t\t\"ifsc\": \"KKBK0023569\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Third Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"611223305\",\n\t\t\t\"ifsc\": \"KKBK0023569\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Third Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"30835594365\",\n\t\t\t\"ifsc\": \"SBIN0007990\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"30835594365\",\n\t\t\t\"ifsc\": \"SBIN0007990\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\"\n\t\t},\n\t\t{\n\t\t\t\"account_number\": \"30835594365\",\n\t\t\t\"ifsc\": \"SBIN0007990\",\n\t\t\t\"amount\": 200,\n\t\t\t\"note\": \"Sample note\",\n\t\t\t\"name\": \"Sreeram's bank account\"\n\t\t}\n\t]\n}"},"url":"{{host}}/api/vp/bank_transfer/bulk_initiate_payment.json","description":"

This API will initiate the payments mentioned in the request in the background, and returns the Payment Order ID (while the payments are being initated in the background)

\n

You can either use the Finly dashboard, or the Payment Order Show API to view the payment order and the associated payments after a while to see the payments initiated.

\n

Parameters:

\n
    \n
  • mode: The mode of bank transfer for these payments. Can be either NEFT / IMPS / RTGS
    • \n
\n

Within each individual payment block:

\n
    \n
  • account_number: Account number of the beneficiary
    • \n
  • ifsc: IFSC of the beneficiary
    • \n
  • amount: Amount of the payment to be made to the beneficiary
    • \n
  • note: Optional note associated with the payment
    • \n
  • name: Name of the bank account to which the payment will be made
    • \n
  • external_reference_id: (optional) Unique reference ID generated from the client's end for their record-keeping. If entered, this will check against previous records to see if any other payment belonging to this particular client contains the same ID - and will prevent creation of duplicate records with the same external reference ID
    • \n
\n","urlObject":{"path":["api","vp","bank_transfer","bulk_initiate_payment.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"145e78bb-67db-61b8-7e6c-34f86132c5e1"},{"name":"Callback Request (to your server)","id":"54f1ca1d-f6ce-48b6-be2d-0d446731bb75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"payment_id\": \n \"payment_amount\": \n\t\"note\": \n \"status\": \n \"receiving_account\": {\n \"receiving_account_type\": \n \"receiving_account_id\": \n \"receiving_account_number\": \n \"receiving_account_ifsc\": \n },\n \"bank_reference_number\": \n \"errors\": []\n}"},"url":"{{Your Custom URL}}","description":"

These are the parameters that will be hitting your custom endpoint for every payment that is initiated from Finly

\n

Parameters:

\n
    \n
  • payment_id: ID of the payment that was processed
    • \n
  • payment_amount: Amount value of the payment that was processed
    • \n
  • note: Any narration that is associated with the payment (set during Initiate Payment API call)
    • \n
  • status: Status of the payment - (Completed / Failed / Processed. Awaiting Credit Confirmation)
    • \n
  • receiving_account:
    • \n
  • receiving_account_type: \"Bank Account\" - will always be the same because the beneficiary is always a bank account
    • \n
  • receiving_account_id: ID of the receiving account in our database
    • \n
  • receiving_account_number: Account number of the beneficiary who receives the payment
    • \n
  • receiving_account_ifsc: IFSC of the beneficiary who receives the payment
    • \n
  • bank_reference_number: UTR of the payment (if successful)
    • \n
  • errors: If the payment failed for any reason, the error message for the same (will be an array of strings)
    • \n
\n","urlObject":{"host":["{{Your Custom URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"54f1ca1d-f6ce-48b6-be2d-0d446731bb75"},{"name":"Get Payment Status","id":"487766ea-4db6-46c1-8cce-371baf654518","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{host}}/api/vp/bank_transfer/payment_status/{{id}}.json","description":"

This API will take the ID of a particular payment that was initiated previously and return the status of the payment

\n

-id: ID of the payment for which you want to check the status

\n","urlObject":{"path":["api","vp","bank_transfer","payment_status","{{id}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"487766ea-4db6-46c1-8cce-371baf654518"}],"id":"421d7b31-e484-65c1-2513-83da93b0f722","_postman_id":"421d7b31-e484-65c1-2513-83da93b0f722","description":""},{"name":"Invoice","item":[{"name":"Payment Link","item":[],"id":"738f5de2-82c8-5527-757b-68ef462db5c3","_postman_id":"738f5de2-82c8-5527-757b-68ef462db5c3","description":""},{"name":"Invoice","item":[{"name":"Create Invoice","id":"ce2a30c3-7860-4d29-6ce1-38986c6ebedd","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"name\": \"Stark Industries\",\n\t\t\"description\": \"Main Supplier of advanced machinery\",\n\t\t\"id\": 4\n\t},\n\t\"invoice\": {\n\t\t\"gst_type_id\": 1,\n\t\t\"date\": \"21-03-2018\",\n\t\t\"due_date\": \"22-03-2018\",\n\t\t\"billing_address\": \"Sample billing address\",\n\t\t\"shipping_address\": \"Sample shipping address\",\n\t\t\"email\": \"sreeram.nr@finly.io\",\n\t\t\"mobile_number\": \"998898998\",\n\t\t\"invoice_number\": \"INV1234528\",\n\t\t\"advance_amount_attributes\": {\n\t\t\t\"value\": 200,\n\t\t\t\"currency_id\": 1\n\t\t},\n\t\t\"freight_amount_attributes\": {\n\t\t\t\"value\": 200,\n\t\t\t\"currency_id\": 1\n\t\t},\n\t\t\"invoice_items_attributes\": [\n\t\t\t{\n\t\t\t\t\"description\": \"Felt Pens\", \n\t\t\t\t\"hsn_sac\": \"HSN\",\n\t\t\t\t\"quantity\": 1,\n\t\t\t\t\"rate\": \"500\",\n\t\t\t\t\"discount\": \"10\",\n\t\t\t\t\"tax\": \"18\",\n\t\t\t\t\"custom_fields\": {\n\t\t\t\t\t\"{{Custom Field ID 1}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 2}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 3}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 4}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 5}}\": \"Custom Field Text\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"description\": \"Lead Pencils\", \n\t\t\t\t\"hsn_sac\": \"HSN\",\n\t\t\t\t\"quantity\": \"10\",\n\t\t\t\t\"rate\": \"200\",\n\t\t\t\t\"discount\": \"10\",\n\t\t\t\t\"tax\": \"12\",\n\t\t\t\t\"custom_fields\": {\n\t\t\t\t\t\"{{Custom Field ID 1}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 2}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 3}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 4}}\": \"Custom Field Text\",\n\t\t\t\t\t\"{{Custom Field ID 5}}\": \"Custom Field Text\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"{{host}}/invoices.json","description":"

This API will create an Invoice with the details specified in the API and send the same to the customer (to the specified email ID that is mentioned in the request).

\n

INVOICE

\n
    \n
  • gst_type_id: Whether the tax being levied is IGST, or SGST + CGST. Use 1 - IGST, 2 - CGST + SGST
    • \n
  • date: Date of generation of invoice.
    • \n
  • due_date: Due date of the invoice
    • \n
  • billing_address: Billing address of the invoice
    • \n
  • shipping_address: Shipping address of the invoice
    • \n
  • email: Email address of the recipient of the invoice
    • \n
  • mobile_number: Mobile number of the recipient
    • \n
  • invoice_number: Invoice number, which by legal mandate, has to be serially generated for each invoice
    • \n
  • advance_amount_attributes[value]: The absolute amount of the advance paid against this invoice, if any
    • \n
  • advance_amount_attributes[currency_id]: Currency ID of the advance amount paid. 1 by default, means INR
    • \n
  • freight_amount_attributes[value]: Freight amount charged against this invoice
    • \n
  • freight_amount_attributes[currency_id]: Freight amount currency - 1 by default, means INR
    • \n
  • invoice_items_attributes: This will be an array of objects, each object representing one particular invoice item
      \n
    • description: Name / Description of the invoice item
      • \n
    • rate: Cost per unit of the invoice item
      • \n
    • quantity: Quantity of the item being invoices
      • \n
    • hsn_sac: The HSN/SAC code of the item being invoices
      • \n
    • discount: Discount rate being offerred for this particular item
      • \n
    • tax: Tax rate being levied for this invoice item
      • \n
    • custom_fields: This will be a hash with the key as the custom field ID, and the value as the value of that particular custom field. The IDs will be shared with you based on request
      • \n
    \n
    • \n
\n

CUSTOMER

\n
    \n
  • id: ID of the customer to whom this invoice is going to be sent. If ID is passed a new customer won't be created (and the below name and description field will be disregarded)
    • \n
  • name: Name of the customer
    • \n
  • description: Brief description of the customer's details
    • \n
\n","urlObject":{"path":["invoices.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce2a30c3-7860-4d29-6ce1-38986c6ebedd"},{"name":"Index","id":"1ba5031a-08cf-46b6-8c14-6e0fd6eedfeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/vp/v1/invoices.json?page=1","description":"

The API endpoint will serve the invoice list which are available in finly

\n","urlObject":{"path":["api","vp","v1","invoices.json"],"host":["{{host}}"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"1ba5031a-08cf-46b6-8c14-6e0fd6eedfeb"}],"id":"5510f1d0-e7db-db5f-8a20-f58226c9f658","_postman_id":"5510f1d0-e7db-db5f-8a20-f58226c9f658","description":""},{"name":"Customers","item":[{"name":"Create","id":"4c88042b-dc6a-ea48-9290-423c052a3106","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer\":{\n\t\t\"name\":\"Wayne Industries\", \n\t\t\"mobile_number\":\"9988998899\", \n\t\t\"email\":\"customer@finly.io\", \n\t\t\"gst\":\"GST99889909\", \n\t\t\"pan\":\"SOMETHING\", \n\t\t\"description\":\"Totally not funding Batman's operations\", \n\t\t\"addresses_attributes\":[\n\t\t\t{\n\t\t\t\t\"address_name\":\"My address\", \n\t\t\t\t\"name\":\"Sreeram\", \n\t\t\t\t\"line_1\":\"#33/1-1, 4th cross road, \", \n\t\t\t\t\"line_2\":\"16th main\", \n\t\t\t\t\"landmark\":\"Chowdiah memorial hall\", \n\t\t\t\t\"city\":\"Bengaluru\", \n\t\t\t\t\"pin_code\":\"560009\", \n\t\t\t\t\"state_id\":\"2\",\n\t\t\t\t\"default\": 1\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"address_name\":\"Second address\", \n\t\t\t\t\"name\":\"Sreeram Second\", \n\t\t\t\t\"line_1\":\"#32, 6th cross road, \", \n\t\t\t\t\"line_2\":\"17th C main\", \n\t\t\t\t\"landmark\":\"Eiffel Tower\", \n\t\t\t\t\"city\":\"Bengaluru\", \n\t\t\t\t\"pin_code\":\"560090\", \n\t\t\t\t\"state_id\":\"2\",\n\t\t\t\t\"default\": 1\n\t\t\t}\n\t\t], \n\t\t\"create_virtual_account\":\"1\", \n\t\t\"virtual_bank_accounts_attributes\":[\n\t\t\t{\n\t\t\t\t\"name\":\"Main Account\"\n\t\t\t}\n\t\t]\n\t}, \n\t\"view\":\"admin\"\n}"},"url":"{{host}}/invoices/customers.json","description":"

This API will create a customer in Finly with the details you provide, and create a virtual account associated with them for accepting payments from them.

\n

CUSTOMER

\n
    \n
  • name: Name of the customer being created
    • \n
  • mobile_number: Mobile number of the customer
    • \n
  • email: Email ID of the customer
    • \n
  • gst: GSTIN of the customer being created
    • \n
  • pan: PAN of the customer being created
    • \n
  • description: Optional description for the customer being created
    • \n
  • create_virtual_account: Flag that creates a virtual account for a particular customer. It's set to true (1) by default, can be changed to 0 if you wish to not associated a virtual account with a customer
    • \n
\n

Virtual Account Attributes:

\n
    \n
  • name: Name of the virtual account you are creating for the customer if the create_virtual_account flag is enabled
    • \n
\n

NOTE: Multiple addresses can be added for one particular customer, pass them as arrays of objects inside the addresses_attributes key

\n

Address attributes:

\n
    \n
  • address_name: Name of the address being added
    • \n
  • name: Name of the customer / building the address
    • \n
  • line_1: Line 1 of the customer's address
    • \n
  • line_2: Line 2 of the customer's address
    • \n
  • landmark: Landmark for the customer's address
    • \n
  • city: City of the customer's address
    • \n
  • pin_code: PIN code of the custommer's address
    • \n
  • default: Set this flag to true if this is the default address of the customer being created. Typically when a customer is being billed from different locations
    • \n
\n","urlObject":{"path":["invoices","customers.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c88042b-dc6a-ea48-9290-423c052a3106"},{"name":"Show","id":"75eecf04-6f0c-3289-979b-b86e7b941b0d","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/invoices/customers/17.json","urlObject":{"path":["invoices","customers","17.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"75eecf04-6f0c-3289-979b-b86e7b941b0d"},{"name":"Update","id":"c1a648df-af45-34b2-a0cf-a9e4367bf585","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer\":{\n\t\t\"name\":\"Practo\", \n\t\t\"mobile_number\":\"9676869654\", \n\t\t\"email\":\"abc@abc.com\", \n\t\t\"gst\":\"GST!\", \n\t\t\"pan\":\"PAN\", \n\t\t\"description\":\"Enter description for merchant here\"\n\t}\n}"},"url":"{{host}}/invoices/customers/17.json","description":"

This API will update the details of a particular customer with the ones passed in the request

\n

CUSTOMER

\n
    \n
  • name: Name of the customer
    • \n
  • mobile_number: Mobile number of the customer
    • \n
  • email: Email ID of the customer
    • \n
  • gst: GSTIN of the customer
    • \n
  • pan: PAN number of the customer
    • \n
  • description: Description of the customer
    • \n
\n","urlObject":{"path":["invoices","customers","17.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1a648df-af45-34b2-a0cf-a9e4367bf585"}],"id":"734733af-023e-9b9e-14f2-c7eb85d35947","_postman_id":"734733af-023e-9b9e-14f2-c7eb85d35947","description":""},{"name":"Inventory Item","item":[{"name":"Create","id":"6eb7aff1-7d3b-b729-d8c2-e66fafd41a69","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"inventory_item\": {\n\t\t\"rate\": 20,\n\t\t\"discount\": 15,\n\t\t\"tax\": 18,\n\t\t\"description\": \"Sample Description\",\n\t\t\"hsn_sac\": \"HSN\",\n\t\t\"sku\": \"SKU\",\n\t\t\"note\": \"Sample note\"\n\t}\n}"},"url":"{{host}}/api/vp/v1/inventory_line_items.json","description":"

This API can be used to create a inventory line item in your Finly account

\n

Parameters:

\n
    \n
  • rate: Rate per item of this inventory item
    • \n
  • discount: Default discount for this particular inventory item
    • \n
  • tax: Tax rate for this inventory item
    • \n
  • description: Description / Name for the inventory item
    • \n
  • sku: SKU for the inventory item
    • \n
  • note: Note
    • \n
  • hsn_sac: HSN/SAC number for the inventory item
    • \n
  • category_id: Category ID for the inventory item
    • \n
\n","urlObject":{"path":["api","vp","v1","inventory_line_items.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6eb7aff1-7d3b-b729-d8c2-e66fafd41a69"},{"name":"Index","id":"df701a7e-6bc5-01e2-c4a3-88347534877b","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/api/vp/v1/inventory_line_items.json","description":"

This API will return the list of inventory items that are added for your company in Finly

\n","urlObject":{"path":["api","vp","v1","inventory_line_items.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"df701a7e-6bc5-01e2-c4a3-88347534877b"}],"id":"e2935199-a0a5-1d31-efe1-5aff6273dd12","_postman_id":"e2935199-a0a5-1d31-efe1-5aff6273dd12","description":""}],"id":"a719470a-38a6-e4e1-3e56-e56f67626edc","_postman_id":"a719470a-38a6-e4e1-3e56-e56f67626edc","description":""},{"name":"Expense Management","item":[{"name":"Expenses","item":[{"name":"Create","id":"f6f6c8c0-4cca-4090-87cf-3c1db276cdf5","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": \"user@email.com\",\n \"type\": \"cash\",\n \"expense\":{\n \"amount_attributes\":{\n \"value\":\"10\",\n \"currency\":\"INR\"\n },\n \"merchant\": \"Uber\",\n \"date\":\"28-Apr-2017\",\n \"category_id\":\"1\",\n \"note\":\"abinash\",\n \"expense_status_id\":\"1\"\n },\n \"custom_fields\":{\n \"cost_center\": \"Bangalore\"\n },\n \"receipt_ids\": \"16\"\n}"},"url":"{{host}}/api/em/v1/expenses.json","description":"

Create expenses on Expense Management using API

\n","urlObject":{"path":["api","em","v1","expenses.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6f6c8c0-4cca-4090-87cf-3c1db276cdf5"}],"id":"2db9d0ee-b3f3-4c10-8e6b-ae765cb1f9e8","_postman_id":"2db9d0ee-b3f3-4c10-8e6b-ae765cb1f9e8","description":""}],"id":"b777eb8d-7cb3-48fd-9873-34d4a8037516","_postman_id":"b777eb8d-7cb3-48fd-9873-34d4a8037516","description":""},{"name":"Callback Testers","item":[{"name":"Successful Vendor Payment","id":"f3e40744-debd-99b8-2663-8b8bbfc378a4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"payment_id\": 1234,\n\t\"payment_amount\": \"400\",\n\t\"note\": \"Enter note here\",\n\t\"status\": \"completed\",\n\t\"receiving_account\": {\n\t\t\"receiving_account_type\": \"BankAccount\",\n\t\t\"receiving_account_id\": 322,\n\t\t\"receiving_account_number\": \"11223344\",\n\t\t\"receiving_account_ifsc\": \"IFSC0099887\"\n\t}\n}"},"url":"{{host}}/api/callbacks/successful_vendor_payment.json","urlObject":{"path":["api","callbacks","successful_vendor_payment.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3e40744-debd-99b8-2663-8b8bbfc378a4"}],"id":"25ab0e3f-fd56-5b21-d2c1-c7d60f8de293","_postman_id":"25ab0e3f-fd56-5b21-d2c1-c7d60f8de293","description":""},{"name":"Virtual Account","item":[{"name":"Test","item":[{"name":"Test Transaction","id":"83f0d929-7291-3daa-638d-5d5c52c2f8f4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer_code\": \"222555\",\n \"bene_account_no\": \"2225554041032569\",\n \"bene_account_ifsc\": \"YESB0CMSNO\",\n \"bene_full_name\": \"anil kumar\",\n \"transfer_type\": \"IMPS\",\n \"transfer_unique_no\": \"TEST235685\",\n \"transfer_timestamp\": \"2017-11-03 17:23:17\",\n \"transfer_ccy\": \"INR\",\n \"transfer_amt\": 66.88,\n \"rmtr_account_no\": \"00531370003086\",\n \"rmtr_account_ifsc\": \"UTIB00001612\",\n \"rmtr_account_type\": \"10\",\n \"rmtr_full_name\": \"PRAMOD UNNIKRISHNAN\",\n \"rmtr_address\": \"PRAMOD UNNIKRISHNANNO 473A GROUND FLOORBANSHANKARI NILAYA 10TH MAIN6TH STAGE BEML LAYOUT\",\n \"attempt_no\": 4,\n \"rmtr_to_bene_note\": \"pass\",\n \"status\": \"CREDITED\",\n \"credit_acct_no\": \"765433456789\",\n \"credited_at\": \"2017-07-27T11:48:02\"\n}"},"url":"{{host_collect}}/test_transaction.json","description":"

Use this API to test money that will be credited to your Finly Account when a bank transaction is made to one of your Virtual Accounts. This simulates the callback received on successful completion of a payment to your virtual account

\n
    \n
  • bene_account_no : The virtual Account number to which you have received a payment
    • \n
  • bene_account_ifsc: IFSC Number of the Virtual Account
    • \n
  • transfer_type: Mode of transfer to the Virtual Account
    • \n
  • transfer_unique_no: Unique Transaction ID for the incoming payment
    • \n
  • transfer_timestamp: Timestamp of the credit to the virtual account
    • \n
  • transfer_ccy: Currency in which the incoming money was transferred
    • \n
  • transfer_amt: Amount of the incoming transaction
    • \n
  • rmtr_account_no: Remitter account number - i.e. account from which money was transferred
    • \n
  • rmtr_account_ifsc: IFSC code of the remitter's account
    • \n
  • rmtr_full_name: Full name of the remitter
    • \n
  • rmtr_address: Address of the remitter
    • \n
  • rmtr_to_bene_note: Note entered by the creditor during credit
    • \n
  • status: Status of the transaction that was credit
    • \n
  • credit_acct_no:
    • \n
  • credited_at: Timestamp of the credit transaction
    • \n
\n","urlObject":{"path":["test_transaction.json"],"host":["{{host_collect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"83f0d929-7291-3daa-638d-5d5c52c2f8f4"}],"id":"e9b21b68-0438-1d3f-507c-2fcece01ecd3","_postman_id":"e9b21b68-0438-1d3f-507c-2fcece01ecd3","description":""},{"name":"Webhooks","item":[{"name":"virtual_account.funds_received","id":"5459f9f7-a34e-b880-5d1c-d376cddca3f2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"event\": \"collect.transaction\",\n \"account_number\": \"222555XXXXXXXXXXXXXX\",\n \"beneficiary_account_no\": \"222555XXXXXXXXXXXXXX\",\n \"beneficiary_account_ifsc\": \"IFSC00123\",\n \"beneficiary_full_name\": \"Your Company Name\",\n \"transfer_type\": \"NEFT\",\n \"transfer_id\": \"KKBKH17312611586\",\n \"transfer_timestamp\": \"2017-11-08 15:38:49\",\n \"transfer_currency\": \"INR\",\n \"transfer_amount\": \"1000\",\n \"remitter_account_no\": \"817293817293\",\n \"remitter_account_ifsc\": \"ICICI9187923\",\n \"remitter_account_type\": \"CA\",\n \"remitter_full_name\": \"Amar Surendra Bhartia\",\n \"remitter_address\": null,\n \"note\": \"Payment against invoice\",\n \"transfer_status\": \"CREDITED\",\n \"credited_at\": \"2017-11-08 15:39:43\",\n \"returned_at\": null,\n \"attempt_no\": 1,\n \"reject_reason\": null\n}"},"url":"{{your_end_point}}","description":"

Triggered everytime the virtual account receives a new acceptable transaction.\nAcceptable transactions are transactions which meet the criteria defined for the virtual account.

\n

Parameters:

\n
    \n
  • account_number: Account number to which money was credited
    • \n
  • beneficiary_account_no: Account number to which money was credited
    • \n
  • beneficiary_account_ifsc: IFSC of the beneficiary account number
    • \n
  • beneficiary_full_name: \"Your Company Name\",
    • \n
  • transfer_type: Transfer type of the transaction - NEFT, IMPS or RTGS
    • \n
  • transfer_id: UTR of the transaction
    • \n
  • transfer_timestamp: Timestamp of credit
    • \n
  • transfer_currency: Currency of the transaction (typically INR)
    • \n
  • transfer_amount: Transfer amount
    • \n
  • remitter_account_no: Account number of the remitter (source account)
    • \n
  • remitter_account_ifsc: IFSC of the remitter (source account)
    • \n
  • remitter_account_type: Current account (CA) or Savings account (SA)
    • \n
  • remitter_full_name: Account name of remitter (source account)
    • \n
  • remitter_address: Address of the remitter (source account)
    • \n
  • note: Payment narration
    • \n
  • transfer_status: Status of the transfer
    • \n
  • credited_at: Timestamp of crediting to Finly pool account
    • \n
\n","urlObject":{"host":["{{your_end_point}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5459f9f7-a34e-b880-5d1c-d376cddca3f2"}],"id":"5f02342f-4155-3fd6-8139-e46febfd80a2","_postman_id":"5f02342f-4155-3fd6-8139-e46febfd80a2","description":""},{"name":"Create","id":"8812c852-4b13-bf81-5fa3-6eee01b4a440","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_number\": \"\",\n \"active\": true,\n \"maximum_amount\": \"10000\",\n \"minimum_transaction_amount\": \"15000\",\n \"maximum_transaction_amount\": \"12000\",\n \"exact_transaction_amount\": \"10000\",\n \"allowed_transaction_count\": 5,\n \"current_account\": true,\n \"savings_account\": true,\n \"neft\": true,\n \"imps\": true,\n \"rtgs\": true,\n \"upi\": true,\n \"active_after\": \"27-02-2019\",\n \"expires_by\": \"31-05-2019\",\n \"date_on\": \"\",\n \"receivable_bank_accounts_attributes\": [\n \t{\n \t\t\"account_number\": \"123456456123\",\n \t\t\"ifsc\": \"IFSC2255225\"\n \t}\t\n ]\n}"},"url":"{{host}}/virtual_accounts.json","description":"
    \n
  • account_number: (Optional) Account number of the virtual account. Ex: 222555YOURCOMPANYCLIENTID. If no value is provided, a default account number would be generated
    • \n
  • active: (Optional) Set active as false if you wish to not accept Payments with this account number. (DEFAULT: true)
    • \n
  • maximum_amount: (Optional) Maximum amount the account can accept after which it will stop accepting payments
    • \n
  • minimum_transaction_amount: (Optional) Minimum amount required on every transaction. The virtual account will not accept payments less than the defined minimum_transaction_amount
    • \n
  • maximum_transaction_amount: (Optional) Maximum amount that can be accepted in one transaction transaction. The virtual account will not accept payments less than the defined minimum_transaction_amount
    • \n
  • exact_transaction_amount: (Optional) Amount that can be accepted in one transaction. Virtual account will not accept payments unless the transaction amount matched this amount
    • \n
  • allowed_transaction_count: (Optional) Number of transactions that can be accepted in this virtual account
    • \n
  • current_account: (Optional) If payments from Current Account should be accepted. (DEFAULT: true)
    • \n
  • savings_account: (Optional) If payments from Savings Account should be accepted. (DEFAULT: true)
    • \n
  • neft: (Optional) If payments initiated via NEFT should be accepted. (DEFAULT: true)
    • \n
  • imps: (Optional) If payments initiated via IMPS should be accepted. (DEFAULT: true)
    • \n
  • rtgs: (Optional) If payments initiated via RTGS should be accpeted. (DEFAULT: true)
    • \n
  • upi: (Optional) If payments initated via UPI should be accepted. (DEFAULT: true)
    • \n
  • active_after: (Optional) Payments would only be accepted after the defined date.
    • \n
  • expires_by: (Optional) Payments would only be accepted till the defined date.
    • \n
  • active_on: (Optional) Payments would only be accepted if it is the same as the defined date.
    • \n
  • receivable_bank_accounts_attributes: (Optional) The respective bank accounts that you want to restrict payments to this virtual account from
    • \n
\n","urlObject":{"path":["virtual_accounts.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"96c3d00d-b67c-a473-4408-677a83606cb4","name":"Create - Failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"account_number\": \"XXXXXXXXXX\",\n\t\"active\": true,\n\t\"maximum_amount\": \"10000\",\n\t\"minimum_transaction_amount\": \"15000\",\n\t\"maximum_transaction_amount\": \"12000\",\n\t\"exact_transaction_amount\": \"10000\",\n\t\"allowed_transaction_count\": 5,\n\t\"current_account\": true,\n\t\"savings_account\": true,\n\t\"neft\": true,\n\t\"imps\": true,\n\t\"rtgs\": true,\n\t\"upi\": true,\n\t\"date_after\": \"12-10-2018\",\n\t\"date_before\": \"12-10-2018\",\n\t\"date_on\": \"1810-2018\"\n}"},"url":"{{host}}/virtual_accounts.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n\t\"success\": false,\n \"messages\": {\n \"error\": [\"Invalid Account Number Format\",\"Invalid date_on format\"],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n }\n}"},{"id":"f970383a-f122-d3f4-8578-f6472e326357","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"account_number\": \"FINLY1XXXXXXXXXXXXXX\",\n\t\"active\": true,\n\t\"maximum_amount\": \"10000\",\n\t\"minimum_transaction_amount\": \"15000\",\n\t\"maximum_transaction_amount\": \"12000\",\n\t\"exact_transaction_amount\": \"10000\",\n\t\"allowed_transaction_count\": 5,\n\t\"current_account\": true,\n\t\"savings_account\": true,\n\t\"neft\": true,\n\t\"imps\": true,\n\t\"rtgs\": true,\n\t\"upi\": true,\n\t\"date_after\": \"12-10-2018\",\n\t\"date_before\": \"12-10-2018\",\n\t\"date_on\": \"18-10-2018\"\n}"},"url":"{{host}}/virtual_accounts.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n\t\"success\": true,\n \"messages\": {\n \"error\": [],\n \"success\": [\"Account Created Successfully\"],\n \"message\": [],\n \"notice\": []\n }\n}"}],"_postman_id":"8812c852-4b13-bf81-5fa3-6eee01b4a440"},{"name":"Update","id":"067804a3-9703-9cc5-3c9e-a69cb2533c05","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"active\": true,\n \"maximum_amount\": \"10000\",\n \"minimum_transaction_amount\": \"15000\",\n \"maximum_transaction_amount\": \"12000\",\n \"exact_transaction_amount\": \"10000\",\n \"allowed_transaction_count\": 5,\n \"current_account\": true,\n \"savings_account\": true,\n \"neft\": true,\n \"imps\": true,\n \"rtgs\": true,\n \"upi\": true,\n \"active_after\": \"27-02-2019\",\n \"expires_by\": \"31-05-2019\",\n \"date_on\": \"18-10-2018\"\n}"},"url":"{{host}}/virtual_accounts/{{virtual_account_number}}.json","description":"
    \n
  • active: (Optional) Set active as false if you wish to not accept Payments with this account number. (DEFAULT: true)
    • \n
  • maximum_amount: (Optional) Maximum amount the account can accept after which it will stop accepting payments
    • \n
  • minimum_transaction_amount: (Optional) Minimum amount required on every transaction. The virtual account will not accept payments less than the defined minimum_transaction_amount
    • \n
  • maximum_transaction_amount: (Optional) Maximum amount that can be accepted in one transaction transaction. The virtual account will not accept payments less than the defined minimum_transaction_amount
    • \n
  • exact_transaction_amount: (Optional) Amount that can be accepted in one transaction. Virtual account will not accept payments unless the transaction amount matched this amount
    • \n
  • allowed_transaction_count: (Optional) Number of transactions that can be accepted in this virtual account
    • \n
  • current_account: (Optional) If payments from Current Account should be accepted. (DEFAULT: true)
    • \n
  • savings_account: (Optional) If payments from Savings Account should be accepted. (DEFAULT: true)
    • \n
  • neft: (Optional) If payments initiated via NEFT should be accepted. (DEFAULT: true)
    • \n
  • imps: (Optional) If payments initiated via IMPS should be accepted. (DEFAULT: true)
    • \n
  • rtgs: (Optional) If payments initiated via RTGS should be accpeted. (DEFAULT: true)
    • \n
  • upi: (Optional) If payments initated via UPI should be accepted. (DEFAULT: true)
    • \n
  • active_after: (Optional) Payments would only be accepted after the defined date.
    • \n
  • expires_by: (Optional) Payments would only be accepted till the defined date.
    • \n
  • active_on: (Optional) Payments would only be accepted if it is the same as the defined date.
    • \n
\n","urlObject":{"path":["virtual_accounts","{{virtual_account_number}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"3ab4e4c4-72fc-cf56-0534-83511ec3f12b","name":"Update","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"active\": true,\n\t\"maximum_amount\": \"10000\",\n\t\"minimum_transaction_amount\": \"15000\",\n\t\"maximum_transaction_amount\": \"12000\",\n\t\"exact_transaction_amount\": \"10000\",\n\t\"allowed_transaction_count\": 5,\n\t\"current_account\": true,\n\t\"savings_account\": true,\n\t\"neft\": true,\n\t\"imps\": true,\n\t\"rtgs\": true,\n\t\"upi\": true,\n\t\"date_after\": \"12-10-2018\",\n\t\"date_before\": \"12-10-2018\",\n\t\"date_on\": \"18-10-2018\"\n}"},"url":"{{host}}/virtual_accounts/{{virtual_account_number}}.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n\t\"success\": true,\n \"messages\": {\n \"error\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n }\n}"}],"_postman_id":"067804a3-9703-9cc5-3c9e-a69cb2533c05"},{"name":"Show","id":"eab4482a-8266-2d24-d8a4-acb1009d605b","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_number\": \"FINLY1XXXXXXXXXXXXXX\",\n \"active\": true,\n \"maximum_amount\": \"10000\",\n \"minimum_transaction_amount\": \"15000\",\n \"maximum_transaction_amount\": \"12000\",\n \"exact_transaction_amount\": \"10000\",\n \"allowed_transaction_count\": 5,\n \"current_account\": true,\n \"savings_account\": true,\n \"neft\": true,\n \"imps\": true,\n \"rtgs\": true,\n \"upi\": true,\n \"date_after\": \"12-10-2018\",\n \"date_before\": \"12-10-2018\",\n \"date_on\": \"18-10-2018\"\n}"},"url":"{{host}}/virtual_accounts/2225550687630817.json","description":"
    \n
  • account_number: Account number of the virtual account. Ex: 222555XXXXXXXXXXXX. If no value is provided, a default account number would be generated
    • \n
  • active: Set active as false if you wish to not accept Payments with this account number. (DEFAULT: true)
    • \n
  • maximum_amount: Maximum amount the account can accept after which it will stop accepting payments
    • \n
  • minimum_transaction_amount: Minimum amount required on every transaction. The virtual account will not accept payments less than the defined minimum_transaction_amount
    • \n
  • maximum_transaction_amount: Maximum amount that can be accepted in one transaction transaction. The virtual account will not accept payments less than the defined minimum_transaction_amount
    • \n
  • exact_transaction_amount: Amount that can be accepted in one transaction. Virtual account will not accept payments unless the transaction amount matched this amount
    • \n
  • allowed_transaction_count: Number of transactions that can be accepted in this virtual account
    • \n
  • current_account: If payments from Current Account should be accepted. (DEFAULT: true)
    • \n
  • savings_account: If payments from Savings Account should be accepted. (DEFAULT: true)
    • \n
  • neft: If payments initiated via NEFT should be accepted. (DEFAULT: true)
    • \n
  • imps: If payments initiated via IMPS should be accepted. (DEFAULT: true)
    • \n
  • rtgs: If payments initiated via RTGS should be accpeted. (DEFAULT: true)
    • \n
  • upi: If payments initated via UPI should be accepted. (DEFAULT: true)
    • \n
  • active_after: Payments would only be accepted after the defined date.
    • \n
  • expires_by: Payments would only be accepted till the defined date.
    • \n
  • active_on: Payments would only be accepted if it is the same as the defined date.
    • \n
  • total_transaction_count: Number of transactions so far
    • \n
  • total_transaction_amount: Total Transaction Amount so far
    • \n
\n","urlObject":{"path":["virtual_accounts","2225550687630817.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"0a8196b9-0d83-05ea-b396-11161337b470","name":"Show","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"account_number\": \"FINLY1XXXXXXXXXXXXXX\",\n\t\"active\": true,\n\t\"maximum_amount\": \"10000\",\n\t\"minimum_transaction_amount\": \"15000\",\n\t\"maximum_transaction_amount\": \"12000\",\n\t\"exact_transaction_amount\": \"10000\",\n\t\"allowed_transaction_count\": 5,\n\t\"current_account\": true,\n\t\"savings_account\": true,\n\t\"neft\": true,\n\t\"imps\": true,\n\t\"rtgs\": true,\n\t\"upi\": true,\n\t\"date_after\": \"12-10-2018\",\n\t\"date_before\": \"12-10-2018\",\n\t\"date_on\": \"18-10-2018\"\n}"},"url":"{{host}}/virtual_accounts/{{virtual_account_number}}.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"success\": false,\n \"messages\": {\n \"error\": [\"Account not found\"],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n }\n}"},{"id":"53bad6a5-15aa-279c-210d-314b927f3d49","name":"Show","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"account_number\": \"FINLY1XXXXXXXXXXXXXX\",\n \"active\": true,\n \"maximum_amount\": \"10000\",\n \"minimum_transaction_amount\": \"15000\",\n \"maximum_transaction_amount\": \"12000\",\n \"exact_transaction_amount\": \"10000\",\n \"allowed_transaction_count\": 5,\n \"current_account\": true,\n \"savings_account\": true,\n \"neft\": true,\n \"imps\": true,\n \"rtgs\": true,\n \"upi\": true,\n \"date_after\": \"12-10-2018\",\n \"date_before\": \"12-10-2018\",\n \"date_on\": \"18-10-2018\"\n}"},"url":"{{host}}/virtual_accounts/{{virtual_account_number}}.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n },\n \"data\": {\n \"account_number\": \"FINLY1XXXXXXXXXXXXXX\",\n \"active\": true,\n \"maximum_amount\": 10000,\n \"minimum_transaction_amount\": 0,\n \"maximum_transaction_amount\": 5000,\n \"exact_transaction_amount\": 0,\n \"allowed_transaction_count\": 2,\n \"current_account\": true,\n \"savings_account\": true,\n \"neft\": true,\n \"imps\": true,\n \"rtgs\": true,\n \"upi\": true,\n \"active_from\": null,\n \"expires_by\": null,\n \"active_on\": \"12-10-2017\",\n \"total_transaction_amount\": 5000,\n \"total_transaction_count\": 1\n }\n}"}],"_postman_id":"eab4482a-8266-2d24-d8a4-acb1009d605b"},{"name":"Deactivate / Destroy","id":"7f31e1c8-faf6-0df0-643a-1a42cfaa72a9","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n}"},"url":"{{host}}/virtual_accounts/{{virtual_account_number}}.json","description":"
    \n

  • virtual_account_number: The acocunt number of the account you wish to deactivate

    \n
    • \n

  • Accounts that have been deactivated will not accept payments after deactivation

    \n
    • \n
\n","urlObject":{"path":["virtual_accounts","{{virtual_account_number}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9da13810-5158-1d66-973b-3f0a01678e2c","name":"Destroy","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n}"},"url":"{{host}}/virtual_accounts/{{virtual_account_number}}.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"success\": true,\n \"messages\": {\n \"error\": [],\n \"success\": [],\n \"message\": [],\n \"notice\": []\n }\n}"}],"_postman_id":"7f31e1c8-faf6-0df0-643a-1a42cfaa72a9"}],"id":"ca3c4584-6370-b4cc-6a3d-8e881068ee81","_postman_id":"ca3c4584-6370-b4cc-6a3d-8e881068ee81","description":""},{"name":"Custom Fields","item":[{"name":"Create","id":"5670312b-dc9e-49ff-bcef-c0200ea9b8e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"field_configuration\": \n\t{\n\t\t\"field_name\": \"Test Drop Down\", \n\t\t\"mandatory\": \"true\", \n\t\t\"configurable_type\": \"Company\", \n\t\t\"field_parent_mappings_attributes\":\n\t\t[\n\t\t\t{\n\t\t\t\t\"field_parent_type_id\": \"3\"\n\t\t\t}, \n\t\t\t{\n\t\t\t\t\"field_parent_type_id\": \"4\"\n\t\t\t}\n\t\t], \n\t\t\"configurable_id\":\"2\", \n\t\t\"field_type_id\":\"5\", \n\t\t\"parent_drop_down_ids\": [\"2\", \"4\"],\n\t\t\"drop_down_items_attributes\": \n\t\t[\n\t\t\t{\n\t\t\t\t\"name\":\"Test 1\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"Test 2\"\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"{{host}}/api/v1/configuration/custom_fields.json","description":"

This API is used to create a custom field for any entity in Finly.

\n

Parameters:

\n
    \n
  • field_name: The name of the field.
    • \n
  • mandatory: Toggles whether this field should be mandatory of optional
    • \n
  • configurable_type: This sets the type of the custom field. Whether it's company-wide, or specific to a particular user, or specific to a policy. Currently only company and policy are supported, so this field will contain either \"Company\" or \"Policy\"
    • \n
  • configurable_id: ID for the above item. If the above is passed as \"Company\", the ID will be that of the company, and accordingly for the policy
    • \n
  • parent_drop_down_ids: Array of drop down items that this field depends on. For example, if a particular field \"Project\" is dependent on another drop down item, \"Finance\", the the ID of the finance field will go here.
    • \n
  • field_parent_mappings_attributes: Will be an array of Field Parent Types that determines under which entity this custom field will appear. It can be Cash Expense, Card Expense, Distance Expense, Report, Money Request, Purchase Order, Invoice etc. Please find below the ID for each of the entities supported:
    • \n
\n

Report => 1,\nMoney request => 2,\nCash expense => 3,\nTime expense => 4,\nDistance expense => 5,\nPer Diem expense => 6,\nCard expense => 7,\nInvoice => 8,\nPurchase Order => 12,\nPurchase Request => 18

\n
    \n
  • field_type_id: The type of the field that will be created. It can be a text, drop down or multi-select drop down. Please find below the IDs for the different types of custom field types:
    • \n
\n

Text => 1, \nDrop down => 5\nMulltiselect => 9

\n
    \n
  • drop_down_items_attributes: If the custom field is a drop down, this will contain a list of the drop down items that will be part of the field
    • \n
  • multiselect_items_attributes: If the custom field is a multi select, this will contain a list of the multi select items that will be part of the field
    • \n
\n","urlObject":{"path":["api","v1","configuration","custom_fields.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5670312b-dc9e-49ff-bcef-c0200ea9b8e2"},{"name":"Update","id":"24d0e4bf-0ccd-4fcf-a365-85f25de5baa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\n}"},"url":"{{host}}/api/v1/configuration/custom_fields/{{ID of Custom Field}}.json","description":"

This API is used to update a custom field for any entity in Finly.

\n

Parameters:

\n
    \n
  • field_name: The name of the field.
    • \n
  • mandatory: Toggles whether this field should be mandatory of optional
    • \n
  • configurable_type: This sets the type of the custom field. Whether it's company-wide, or specific to a particular user, or specific to a policy. Currently only company and policy are supported, so this field will contain either \"Company\" or \"Policy\"
    • \n
  • configurable_id: ID for the above item. If the above is passed as \"Company\", the ID will be that of the company, and accordingly for the policy
    • \n
  • field_parent_mappings_attributes: Will be an array of Field Parent Types that determines under which entity this custom field will appear. It can be Cash Expense, Card Expense, Distance Expense, Report, Money Request, Purchase Order, Invoice etc. Please find below the ID for each of the entities supported:
    • \n
\n

Report => 1,\nMoney request => 2,\nCash expense => 3,\nTime expense => 4,\nDistance expense => 5,\nPer Diem expense => 6,\nCard expense => 7,\nInvoice => 8,\nPurchase Order => 12,\nPurchase Request => 18

\n
    \n
  • field_type_id: The type of the field that will be created. It can be a text, drop down or multi-select drop down. Please find below the IDs for the different types of custom field types:
    • \n
\n

Text => 1, \nDrop down => 5\nMulltiselect => 9

\n
    \n
  • drop_down_items_attributes: If the custom field is a drop down, this will contain a list of the drop down items that will be part of the field
    • \n
  • multiselect_items_attributes: If the custom field is a multi select, this will contain a list of the multi select items that will be part of the field
    • \n
\n","urlObject":{"path":["api","v1","configuration","custom_fields","{{ID of Custom Field}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24d0e4bf-0ccd-4fcf-a365-85f25de5baa8"},{"name":"Index","id":"69ba37df-5a04-4d7f-b7d7-4e125f730ea0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{host}}//api/v1/configuration/custom_fields.json","description":"

This API will return the list of custom fields that are part of this particular company along with details of the parent, and the details around the field

\n","urlObject":{"path":["","api","v1","configuration","custom_fields.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"69ba37df-5a04-4d7f-b7d7-4e125f730ea0"},{"name":"Show","id":"5da37e0a-6e2b-4c0c-a416-9c924a209de6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/api/v1/configuration/custom_fields/{{ID of Custom Field}}.json","description":"

This API will return the details surrounding any particular custom field identified by their ID.

\n","urlObject":{"path":["api","v1","configuration","custom_fields","{{ID of Custom Field}}.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5da37e0a-6e2b-4c0c-a416-9c924a209de6"},{"name":"Add Drop Down Item(s)","id":"c8ac176a-610a-46df-bba8-00dd13536c2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"items\": \n\t[\n\t\t{\n\t\t\t\"name\": \"Sample\"\n\t\t},\n\t\t{\n\t\t\t\"name\": \"Another sample\"\n\t\t}\n\t],\n\t\"field_configuration_id\": \"675\"\n}"},"url":"{{host}}/api/v1/configuration/custom_fields/{{Custom Field ID}}/drop_down_items.json","description":"

This API will let you add drop down items to an existing custom field configuration.

\n

Parameters:

\n
    \n
  • items: This will contain the array of names that need to be added as drop down items to an existing custom field. It will be an array of objects with the key name identifying each item
    • \n
  • field_configuration_id: ID of the custom field that is being edited
    • \n
\n","urlObject":{"path":["api","v1","configuration","custom_fields","{{Custom Field ID}}","drop_down_items.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8ac176a-610a-46df-bba8-00dd13536c2f"},{"name":"Remove Drop Down Item","id":"3f08b868-1d6a-4695-8428-ecf50e37889e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"field_configuration_id\": \"669\", \n\t\"drop_down_item_id\": \"3398\"\n}"},"url":"{{host}}/api/v1/configuration/custom_fields/{{ID of the custom field}}/drop_down_items/{{ID of the drop down}}","description":"

This endpoint will allow you to remove a particular drop down item as an option from one of the custom fields

\n

Parameters:

\n
    \n
  • field_configuration_id: ID of the custom field that is being modified
    • \n
  • drop_down_item_id: ID of the drop down item that is being destroyed / deactivated
    • \n
\n","urlObject":{"path":["api","v1","configuration","custom_fields","{{ID of the custom field}}","drop_down_items","{{ID of the drop down}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f08b868-1d6a-4695-8428-ecf50e37889e"},{"name":"Associate User Drop Downs","id":"6df62fd4-2ac4-4efa-8d9e-0a3e4d8a5d94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_id\": [\"\"],\n\t\"drop_down_ids\": [\"\"]\n}"},"url":"{{host}}/api/v1/configuration/custom_fields/:custom_field_id/associate_user_drop_downs.json","description":"

For a given custom field, this API will let you associate certain drop downs with a bunch of users.

\n

Parameters:

\n
    \n
  • custom_field_id: ID of the custom field whose drop downs are being modified
    • \n
  • drop_down_ids: The drop down item(s) that will be associated with the users in question
    • \n
  • user_id: Array of user IDs (can be email or mobile number) that will be associated with the given drop down
    • \n
\n

All the users passed above, will be associated with all the drop down items passed in the params. If a particular user has already been associated with a drop down, it will be ignored.

\n","urlObject":{"path":["api","v1","configuration","custom_fields",":custom_field_id","associate_user_drop_downs.json"],"host":["{{host}}"],"query":[],"variable":[{"type":"string","value":"","key":"custom_field_id"}]}},"response":[],"_postman_id":"6df62fd4-2ac4-4efa-8d9e-0a3e4d8a5d94"},{"name":"Disassociate User Drop Downs","id":"0510448f-6423-45e5-a290-84f1482ad051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_id\": [\"\"],\n\t\"drop_down_ids\": [\"\"]\n}"},"url":"{{host}}/api/v1/configuration/custom_fields/:custom_field_id/disassociate_user_drop_downs.json","urlObject":{"path":["api","v1","configuration","custom_fields",":custom_field_id","disassociate_user_drop_downs.json"],"host":["{{host}}"],"query":[],"variable":[{"type":"string","value":"","key":"custom_field_id"}]}},"response":[],"_postman_id":"0510448f-6423-45e5-a290-84f1482ad051"},{"name":"Drop Down Items Index","id":"719865e8-417c-4b97-9ecb-90e4cf300412","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/api/v1/configuration/custom_fields/:custom_field_id/drop_down_items.json?filter_user_email_mobile=","description":"

This API gives the list of drop downs that are present within a particular custom field.

\n

Parameters:

\n
    \n
  • custom_field_id: The ID of the custom field whose drop down items you wish to see
    • \n
  • filter_user_email_mobile: If an email or mobile number is passed here, it will return specifically only the drop down items that are mapped to this particular user
    • \n
\n","urlObject":{"path":["api","v1","configuration","custom_fields",":custom_field_id","drop_down_items.json"],"host":["{{host}}"],"query":[{"key":"filter_user_email_mobile","value":""}],"variable":[{"type":"string","value":"","key":"custom_field_id"}]}},"response":[],"_postman_id":"719865e8-417c-4b97-9ecb-90e4cf300412"}],"id":"05e26000-a977-4318-b71f-a0e9d31a89a1","_postman_id":"05e26000-a977-4318-b71f-a0e9d31a89a1","description":""},{"name":"User","item":[],"id":"98d6eefa-afba-4a84-8156-03d5e4ccca34","_postman_id":"98d6eefa-afba-4a84-8156-03d5e4ccca34","description":""}]}