The Platform API is the programming interface to the Fintech platform.
\nThe API can be used to integrate your app or website with Backpack Fintech platform.
\nThis enables partners to maximize the features within your application.
\nThe API follows a REST API design, meaning that you use standard HTTP methods to retrieve and manipulate resources.
The API endpoint requires login using basic HTTP auth.
The endpoint and login credentials will be given to you by your account manager.
\nIn this documentation, the following endpoint will be used: https://platform-api.backpack.com.
\nParameters are accepted over POST or GET and their names are case-sensitive.
-- Our Servers supports Get and Post Calls .
Please note that these API calls refers to Production on SandBox mode that's ignores geographical servers.
After completing tests and QA , in real mode you will need to point the call to the appropriate zone.
\nThe appropriate zone will be delivered to you by Backpack Team .
These are the end points :
Main Zone : https://Platform-api.backpack.io/ (Also SandBox)
\nEuro Zone : https://Platform-api.eu-b.backpack.io/
\nHong Kong Zone : https://Platform-api.hk-a.backpack.io/
\nAsia-Pacific Zone : https://Platform-api.ap-b.backpack.io/
Plese note that our system is also supporing (and encoraging) on production mode using :
curl_setopt($ch, CURLOPT_USERPWD, 'tsdemoapi:YkqCea2R');
insted of
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
\"Authorization: Basic dHNkZW1vYXBpOllrcUNlYTJS\"
));
Required - Unique
\n","type":"text/plain"},"key":"email","value":"user787878@mailinator.com"},{"description":{"content":"Required - MD5 Format
\n","type":"text/plain"},"key":"password","value":"3e6c7d141e32189c917761138b026b74"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"firstName","value":"John"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"lastName","value":"Doe"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"phone","value":"1234567890"},{"description":{"content":"Required - The user's two-character ISO country code
\n","type":"text/plain"},"key":"country","value":"cy"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"userCurrency","value":"1"},{"description":{"content":"Required - Date Of Birth , Expected Format : YYYY-MM-DD
\n","type":"text/plain"},"key":"dob","value":"2000-02-02"},{"description":{"content":"Optional - Free Text , affiliate token (landing parameter), \ncan add more tracking parameters to the array. URL Decoded
\n","type":"text/plain"},"key":"landing","value":"{%22a_aid%22:%22804d5514%22}"},{"description":{"content":"Optional - If set, user will be created as already confirmed
\n","type":"text/plain"},"key":"confirmed","value":"1"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"pass","value":"123456Aa"},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"nationalID","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"locale","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"address1","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"zip","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"State","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"facebookID","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"loginConfirmed","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"vkID","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"qq","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"sendConfirmationEmail","value":""}],"variable":[]}},"response":[{"id":"bf3051d2-0175-49b0-9438-1d471566eb71","name":"Register New User","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/index/register?email=user787878@mailinator.com&password=eaba46ddc692ac867294716b1d68d9e7&firstName=John&lastName=Doe&phone=1234567890&country=cy&userCurrency=1&dob=2000-02-02&landing={%22a_aid%22:%22804d5514%22}&confirmed=1&nationalID&locale&address1&city&zip&State&facebookID&loginConfirmed&vkID&qq&sendConfirmationEmail","host":["https://platform-api.backpack.io"],"path":["index","register"],"query":[{"key":"email","value":"user787878@mailinator.com","description":"Required - Unique "},{"key":"password","value":"eaba46ddc692ac867294716b1d68d9e7","description":"Required - MD5 Format"},{"key":"firstName","value":"John","description":"Required"},{"key":"lastName","value":"Doe","description":"Required"},{"key":"phone","value":"1234567890","description":"Required"},{"key":"country","value":"cy","description":"Required - The user's two-character ISO country code"},{"key":"userCurrency","value":"1","description":"Required "},{"key":"dob","value":"2000-02-02","description":"Required - Date Of Birth , Expected Format : YYYY-MM-DD"},{"key":"landing","value":"{%22a_aid%22:%22804d5514%22}","description":"Optional - Free Text , affiliate token (landing parameter), \ncan add more tracking parameters to the array. URL Decoded "},{"key":"confirmed","value":"1","description":"Optional - If set, user will be created as already confirmed"},{"key":"nationalID","value":null,"description":"Optional"},{"key":"locale","value":null,"description":"Optional"},{"key":"address1","value":null,"description":"Optional"},{"key":"city","value":null,"description":"Optional"},{"key":"zip","value":null,"description":"Optional"},{"key":"State","value":null,"description":"Optional"},{"key":"facebookID","value":null,"description":"Optional"},{"key":"loginConfirmed","value":null,"description":"Optional"},{"key":"vkID","value":null,"description":"Optional"},{"key":"qq","value":null,"description":"Optional"},{"key":"sendConfirmationEmail","value":null,"description":"Optional"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Length","value":"121","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 08:31:34 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\"1111111\""}],"_postman_id":"8ee886ef-d7a8-4be5-8c68-4ca464f01656"},{"name":"Short Registeration New User","id":"dcaff474-423f-454d-a01e-cb70c5491d24","request":{"method":"GET","header":[],"url":"https://platform-api.backpack.io/index/register?email=user78787844@mailinator.com&password=3e6c7d141e32189c917761138b026b74&shortRegistration=1&country=cy&practiceMode=true&pass=123456Aa","auth":{"type":"basic","basic":{"password":"Required - Unique
\n","type":"text/plain"},"key":"email","value":"user78787844@mailinator.com"},{"description":{"content":"Required - MD5 Format
\n","type":"text/plain"},"key":"password","value":"3e6c7d141e32189c917761138b026b74"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"shortRegistration","value":"1"},{"description":{"content":"Required - The user's two-character ISO country code
\n","type":"text/plain"},"key":"country","value":"cy"},{"description":{"content":"Optional - true / false
\n","type":"text/plain"},"key":"practiceMode","value":"true"},{"description":{"content":"Optional - For MT5 / MT4 Users
\n","type":"text/plain"},"key":"pass","value":"123456Aa"},{"disabled":true,"description":{"content":"Required
\n","type":"text/plain"},"key":"firstName","value":"John"},{"disabled":true,"description":{"content":"Required
\n","type":"text/plain"},"key":"lastName","value":"Doe"},{"disabled":true,"description":{"content":"Required
\n","type":"text/plain"},"key":"phone","value":"1234567890"},{"disabled":true,"description":{"content":"Required
\n","type":"text/plain"},"key":"userCurrency","value":"1"},{"disabled":true,"description":{"content":"Required - Date Of Birth , Expected Format : YYYY-MM-DD
\n","type":"text/plain"},"key":"dob","value":"2000-02-02"},{"disabled":true,"description":{"content":"Optional - Free Text , affiliate token (landing parameter), \ncan add more tracking parameters to the array. URL Decoded
\n","type":"text/plain"},"key":"landing","value":"{%22a_aid%22:%22804d5514%22}"},{"disabled":true,"description":{"content":"Optional - If set, user will be created as already confirmed
\n","type":"text/plain"},"key":"confirmed","value":"1"},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"nationalID","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"locale","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"address1","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"zip","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"State","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"facebookID","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"loginConfirmed","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"vkID","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"qq","value":""},{"disabled":true,"description":{"content":"Optional
\n","type":"text/plain"},"key":"sendConfirmationEmail","value":""}],"variable":[]}},"response":[{"id":"023cbb25-d7ec-414f-84c1-c30634a99f73","name":"Short Registeration New User","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/index/register?email=user78787844@mailinator.com&password=3e6c7d141e32189c917761138b026b74&shortRegistration=1&country=cy&practiceMode=true","host":["https://platform-api.backpack.io"],"path":["index","register"],"query":[{"key":"email","value":"user78787844@mailinator.com","description":"Required - Unique "},{"key":"password","value":"3e6c7d141e32189c917761138b026b74","description":"Required - MD5 Format"},{"key":"shortRegistration","value":"1","description":"Required "},{"key":"country","value":"cy","description":"Required - The user's two-character ISO country code"},{"key":"pass","value":"123456Aa","disabled":true},{"key":"practiceMode","value":"true","description":"Optional - true / false "},{"key":"firstName","value":"John","description":"Required","disabled":true},{"key":"lastName","value":"Doe","description":"Required","disabled":true},{"key":"phone","value":"1234567890","description":"Required","disabled":true},{"key":"userCurrency","value":"1","description":"Required ","disabled":true},{"key":"dob","value":"2000-02-02","description":"Required - Date Of Birth , Expected Format : YYYY-MM-DD","disabled":true},{"key":"landing","value":"{%22a_aid%22:%22804d5514%22}","description":"Optional - Free Text , affiliate token (landing parameter), \ncan add more tracking parameters to the array. URL Decoded ","disabled":true},{"key":"confirmed","value":"1","description":"Optional - If set, user will be created as already confirmed","disabled":true},{"key":"nationalID","value":null,"description":"Optional","disabled":true},{"key":"locale","value":null,"description":"Optional","disabled":true},{"key":"address1","value":null,"description":"Optional","disabled":true},{"key":"city","value":null,"description":"Optional","disabled":true},{"key":"zip","value":null,"description":"Optional","disabled":true},{"key":"State","value":null,"description":"Optional","disabled":true},{"key":"facebookID","value":null,"description":"Optional","disabled":true},{"key":"loginConfirmed","value":null,"description":"Optional","disabled":true},{"key":"vkID","value":null,"description":"Optional","disabled":true},{"key":"qq","value":null,"description":"Optional","disabled":true},{"key":"sendConfirmationEmail","value":null,"description":"Optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Length","value":"9","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 08:36:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\"1111111\""}],"_postman_id":"dcaff474-423f-454d-a01e-cb70c5491d24"}],"id":"c0045ff9-bf6b-4e52-b19b-4d2a3696704a","description":"Registers a new user,
\nthis is the primary call for register new users to the system
\nthe response will be UserId that will be a unique identification of the user
Logs a user in and provides a session token for authenticated actions.
This can be done either by email/password, or using the previous session token.
Required
\n","type":"text/plain"},"key":"email","value":"hello@example.com"},{"description":{"content":"Required
\n","type":"text/plain"},"key":"password","value":"eaba46ddc692ac867294716b1d68d9e7"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"session","value":"098f6bcd4621d373cade4e832627b4f6"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"facebookAccessToken","value":"NO5wqpV3gaaPWmCXEbVEoLMMA4Rr6BkaR5CBl11"}],"variable":[]}},"response":[{"id":"21bc53c6-dea8-47b8-a26f-a033593d1bbf","name":"Login","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/index/login?email=hello@example.com&password=eaba46ddc692ac867294716b1d68d9e7&session=098f6bcd4621d373cade4e832627b4f6&facebookAccessToken=NO5wqpV3gaaPWmCXEbVEoLMMA4Rr6BkaR5CBl11","host":["https://platform-api.backpack.io"],"path":["index","login"],"query":[{"key":"email","value":"hello@example.com"},{"key":"password","value":"eaba46ddc692ac867294716b1d68d9e7"},{"key":"session","value":"098f6bcd4621d373cade4e832627b4f6"},{"key":"facebookAccessToken","value":"NO5wqpV3gaaPWmCXEbVEoLMMA4Rr6BkaR5CBl11"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"463","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 09:29:32 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"session\":\"e53e84b71218fa194b726a9053924908\",\"user\":{\"userID\":\"4543929\",\"email\":\"hello@example.com\",\"firstName\":\"hello\",\"lastName\":\"example\",\"dob\":\"1984-08-01\",\"location\":\"hk\",\"confirmed\":\"0\",\"validated\":\"0\",\"frozen\":\"1\",\"blocked\":\"0\",\"affiliateID\":\"\",\"facebookID\":null,\"vkID\":null,\"social\":\"0\",\"nickname\":\"\",\"loginConfirmed\":null,\"tester\":\"0\",\"accountLevel\":\"4\",\"practiceMode\":\"0\",\"firstRealModeDate\":\"2018-04-17 14:04:04\",\"loginDefaultMode\":null,\"locale\":\"en_HK\",\"mobile\":\"+852 55555555\",\"mobile2\":\"\",\"mobile2Verified\":\"0\",\"welcomeEmailSent\":\"1\",\"questionaryDone\":0,\"questionaryRequired\":0,\"questionaryEnabled\":1,\"showQuestionary\":0,\"payoutDeltas\":\"{\\\"1\\\":3,\\\"2\\\":3,\\\"11\\\":3}\",\"questionaryRandom\":\"1\",\"practiceExpired\":0,\"expirationDate\":\"\",\"nextResetDate\":\"\",\"practiceWalletExists\":false},\"loginConfirmed\":0,\"isVKSignUp\":false}"}],"_postman_id":"d16b0c23-df40-49ca-a3a3-562501f4999d"}],"id":"9cf76451-0626-43f2-8229-beb39b349bb3","_postman_id":"9cf76451-0626-43f2-8229-beb39b349bb3","description":"","auth":{"type":"basic","basic":{"password":"Get a list of supported countries.
\n","auth":{"type":"basic","basic":{"password":"Get a list of supported states.
\n","auth":{"type":"basic","basic":{"password":"The index module contains system actions
\nactions that don’t directly correspond to requests made explicitly by a specific logged in user.
Required - Active Session of the User
\n","type":"text/plain"},"key":"session","value":"b9043067b03490052474f89bf0d03f78"}],"variable":[]}},"response":[],"_postman_id":"a090f1a1-2a79-4a79-941b-d74f025374e2"},{"name":"User's Info","id":"4ce8359e-bc99-40eb-bddc-5325df51d62b","request":{"method":"GET","header":[],"url":"https://platform-api.backpack.io/user/info?session=3d279325ee1e4e02c37c709c636b258d","description":"Get the user's personal information.
\n","auth":{"type":"basic","basic":{"password":"Required - Active Session of the User
\n","type":"text/plain"},"key":"session","value":"3d279325ee1e4e02c37c709c636b258d"}],"variable":[]}},"response":[{"id":"7187c2e0-ea8c-4312-84bf-392e5fba1f18","name":"User's Info","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/user/info?session=b9043067b03490052474f89bf0d03f78","host":["https://platform-api.backpack.io"],"path":["user","info"],"query":[{"key":"session","value":"b9043067b03490052474f89bf0d03f78","description":"Required - Active Session of the User"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"476","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 13:18:58 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"platform-api.tradesmarter.com","path":"/","secure":false,"value":"phoi54oqrqcmgohc9miu7g12i2","key":"PHPSESSID"}],"responseTime":null,"body":"{\"userID\":\"4543929\",\"email\":\"hello@example.com\",\"firstName\":\"hello\",\"lastName\":\"example\",\"dob\":\"1984-08-01\",\"mobile\":\"+852 55555555\",\"mobile2\":\"\",\"mobile2Verified\":\"0\",\"qq\":null,\"location\":\"hk\",\"locale\":\"en_HK\",\"nationalID\":\"\",\"confirmed\":\"0\",\"validated\":\"0\",\"frozen\":\"1\",\"blocked\":\"0\",\"affiliateID\":\"\",\"tester\":\"0\",\"facebookID\":null,\"vkID\":null,\"social\":\"0\",\"nickname\":\"\",\"accountLevel\":\"4\",\"userCurrency\":\"1\",\"depositCount\":\"1\",\"practiceMode\":\"0\",\"siteID\":\"23\",\"questionaryDone\":0,\"pushwooshDeviceToken\":null,\"globalConsent\":0,\"fxRiskFactor\":1,\"questionaryRequired\":0,\"questionaryEnabled\":1,\"showQuestionary\":0,\"welcomeEmailSent\":0,\"payoutDeltas\":\"{\\\"1\\\":3,\\\"2\\\":3,\\\"11\\\":3}\",\"questionaryRandom\":\"1\",\"practiceExpired\":0,\"expirationDate\":\"\",\"nextResetDate\":\"\",\"practiceWalletExists\":false,\"address1\":\"\",\"city\":\"\",\"state\":\"\",\"zip\":\"\",\"country\":\"hk\",\"userClass\":2}"}],"_postman_id":"4ce8359e-bc99-40eb-bddc-5325df51d62b"},{"name":"Send Welcome Email","id":"57a43526-e7a9-4eba-a530-9889b785c06e","request":{"method":"GET","header":[],"url":"https://platform-api.backpack.io/user/send-welcome-email?session=b9043067b03490052474f89bf0d03f78","auth":{"type":"basic","basic":{"password":"Required - Active Session of the User
\n","type":"text/plain"},"key":"session","value":"b9043067b03490052474f89bf0d03f78"}],"variable":[]}},"response":[{"id":"3f4577f6-82d3-4bee-a476-03e106acb576","name":"Semd Welcome Email","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/user/send-welcome-email?session=b9043067b03490052474f89bf0d03f78","host":["https://platform-api.backpack.io"],"path":["user","send-welcome-email"],"query":[{"key":"session","value":"b9043067b03490052474f89bf0d03f78"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Length","value":"16","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 12:59:53 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"platform-api.tradesmarter.com","path":"/","secure":false,"value":"phoi54oqrqcmgohc9miu7g12i2","key":"PHPSESSID"}],"responseTime":null,"body":"{\"success\":true}"}],"_postman_id":"57a43526-e7a9-4eba-a530-9889b785c06e"},{"name":"Set User Account Level","id":"80eb2a35-db5f-49b3-bb35-7169f8c61aee","request":{"method":"GET","header":[],"url":"https://platform-api.backpack.io/user/set-user-account-level?session=b9043067b03490052474f89bf0d03f78&accountLevel=4","auth":{"type":"basic","basic":{"password":"Required - Active Session of the User
\n","type":"text/plain"},"key":"session","value":"b9043067b03490052474f89bf0d03f78"},{"description":{"content":"Required - 0 = None , 1=Basic . 2=Bronze ,
3= Silver, 4=Gold , 5=Platinum
Required - Active Session of the User
\n","type":"text/plain"},"key":"session","value":"abe41b407946c43d4c230f4d55bd6584"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"firstName","value":"hello"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"lastName","value":"example"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"nationalID","value":"nationalID"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"dob","value":"1984-08-01"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"phone","value":"43444444444"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"address1","value":"address1"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"city","value":"city"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"zip","value":"555555"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"State","value":"cy"},{"description":{"content":"Optional - Parameter to update
\n","type":"text/plain"},"key":"country","value":"cy"},{"description":{"content":"Optional - Parameter to update , 0= Not Frozen , 1= Frozen
\n","type":"text/plain"},"key":"Frozen","value":"0"},{"description":{"content":"Optional - Parameter to update, 0= Not Blocked, 1= Blocked
\n","type":"text/plain"},"key":"Blocked","value":"0"}],"variable":[]}},"response":[{"id":"204cd033-a874-4672-8baa-cf6101934627","name":"Update User Info ","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/user/update?session=abe41b407946c43d4c230f4d55bd6584&firstName=hello&lastName=example&nationalID=nationalID&dob=1984-08-01&phone=43444444444&address1=address1&city=city&zip=555555&State=cy&country=cy&Frozen=false&Blocked=false","host":["https://platform-api.backpack.io"],"path":["user","update"],"query":[{"key":"session","value":"abe41b407946c43d4c230f4d55bd6584","description":"Required - Active Session of the User"},{"key":"firstName","value":"hello","description":"Optional - Parameter to update"},{"key":"lastName","value":"example","description":"Optional - Parameter to update"},{"key":"nationalID","value":"nationalID","description":"Optional - Parameter to update"},{"key":"dob","value":"1984-08-01","description":"Optional - Parameter to update"},{"key":"phone","value":"43444444444","description":"Optional - Parameter to update"},{"key":"address1","value":"address1","description":"Optional - Parameter to update"},{"key":"city","value":"city","description":"Optional - Parameter to update"},{"key":"zip","value":"555555","description":"Optional - Parameter to update"},{"key":"State","value":"cy","description":"Optional - Parameter to update"},{"key":"country","value":"cy","description":"Optional - Parameter to update"},{"key":"Frozen","value":"false","description":"Optional - Parameter to update"},{"key":"Blocked","value":"false","description":"Optional - Parameter to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Length","value":"4","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 13:55:29 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"platform-api.tradesmarter.com","path":"/","secure":false,"value":"phoi54oqrqcmgohc9miu7g12i2","key":"PHPSESSID"}],"responseTime":null,"body":"true"}],"_postman_id":"4c619206-c061-4a5f-8143-997005e9b894"},{"name":"Reset Paswword Mail - Ajax Call","id":"36fda9df-42d4-4f0a-949f-7417a4df017e","request":{"method":"GET","header":[],"url":"http://bpw.backpack.io/ajax/index/reset-password?email=user@domain.com\n","auth":{"type":"basic","basic":{"password":"Required
\n","type":"text/plain"},"key":"email","value":"user@domain.com\n"}],"variable":[]}},"response":[{"id":"21dc648b-4522-430e-8a70-1673b5dc23fa","name":"Reset Paswword Mail - Ajax Call","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://bpw.backpack.io/ajax/index/reset-password?email=user@domain.com\n","protocol":"http","host":["bpw","backpack","io"],"path":["ajax","index","reset-password"],"query":[{"key":"email","value":"user@domain.com\n","description":"Required"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"success\":true,\"type\":\"\",\"title\":\".....\",\"body\":\"\",\"message\":{\"type\":\"\",\"title\":\"...\",\"body\":\"\"}}\r\n"}],"_postman_id":"36fda9df-42d4-4f0a-949f-7417a4df017e"},{"name":"Auto Login - Redirect User","id":"b830e169-dfa1-4325-91a3-3471ae5a253b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://fx-trading.$brand/index/sign-in?session=$session&keepSession=1&redirectUrl=https://bpw.$brand","auth":{"type":"basic","basic":{"password":"The user module contains action that correspond either to requests made directly by a logged-in user,
\nor actions that deliver user data that directly aid dispatching or performing such requests.
\nAs a rule, these actions are all authenticated using a session token,
\nas provided by Index::login.
Required
\n","type":"text/plain"},"key":"session","value":"abe41b407946c43d4c230f4d55bd6584"}],"variable":[]}},"response":[{"id":"eb61a2cd-9a35-4e05-8caa-f8110167d512","name":"Delete Account Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/account/delete-account-request?userID=4901207","host":["https://platform-api.backpack.io"],"path":["account","delete-account-request"],"query":[{"key":"userID","value":"4901207","description":"Required "}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"103","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 14:29:01 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"platform-api.tradesmarter.com","path":"/","secure":false,"value":"phoi54oqrqcmgohc9miu7g12i2","key":"PHPSESSID"}],"responseTime":null,"body":"{\"success\":true,\"message\":\"The request to delete your account received\",\"deleteRequestID\":\"465\"}"}],"_postman_id":"2a2a236f-0b61-44f2-8192-e2c76e91e07a"},{"name":"Update User Consent","id":"bee2726c-58a9-4719-82c7-a9a09f1753a2","request":{"method":"GET","header":[],"url":"https://platform-api.backpack.io/account/update-user-consent?session=abe41b407946c43d4c230f4d55bd6584&globalConsent=1","auth":{"type":"basic","basic":{"password":"Required
\n","type":"text/plain"},"key":"session","value":"abe41b407946c43d4c230f4d55bd6584"},{"description":{"content":"Required - 1=Confirmed , 0=Not Confirmed
\n","type":"text/plain"},"key":"globalConsent","value":"1"}],"variable":[]}},"response":[{"id":"51ac5fc9-e8f4-4b1e-815d-a39f6f2b7e47","name":"Update User Consent","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/account/update-user-consent?session=abe41b407946c43d4c230f4d55bd6584&globalConsent=1","host":["https://platform-api.backpack.io"],"path":["account","update-user-consent"],"query":[{"key":"session","value":"abe41b407946c43d4c230f4d55bd6584","description":"Required "},{"key":"globalConsent","value":"1","description":"Required - 1=Confirmed , 0=Not Confirmed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Length","value":"16","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 15:00:18 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"platform-api.tradesmarter.com","path":"/","secure":false,"value":"phoi54oqrqcmgohc9miu7g12i2","key":"PHPSESSID"}],"responseTime":null,"body":"{\"success\":true}"}],"_postman_id":"bee2726c-58a9-4719-82c7-a9a09f1753a2"}],"id":"6e684eb2-96c2-46ac-bc55-cac1f4f23d1c","_postman_id":"6e684eb2-96c2-46ac-bc55-cac1f4f23d1c","description":"","auth":{"type":"basic","basic":{"password":"Required - Active Session of the User
\n","type":"text/plain"},"key":"session","value":"b9043067b03490052474f89bf0d03f78"}],"variable":[]}},"response":[{"id":"75d24434-ef44-4285-bc5d-a2e7028d3ebf","name":"Options Wallet Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/user/get-wallet-details?session=b9043067b03490052474f89bf0d03f78","host":["https://platform-api.backpack.io"],"path":["user","get-wallet-details"],"query":[{"key":"session","value":"b9043067b03490052474f89bf0d03f78","description":"Required - Active Session of the User"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"149","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 13:15:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"platform-api.tradesmarter.com","path":"/","secure":false,"value":"phoi54oqrqcmgohc9miu7g12i2","key":"PHPSESSID"}],"responseTime":null,"body":"{\"credit\":10150,\"reserved\":0,\"currency\":\"2\",\"available\":10000,\"bonus\":{\"tradeable\":150,\"pending\":0,\"promotional\":0},\"pendingBonusDetails\":[],\"userCurrency\":1,\"userID\":\"4543929\"}"}],"_postman_id":"6d585d94-474d-469b-8dbe-aecc4834f063"}],"id":"f16e7801-6c5e-447a-a38a-2261d5fddb50","_postman_id":"f16e7801-6c5e-447a-a38a-2261d5fddb50","description":"","auth":{"type":"basic","basic":{"password":"Retrieves tradeable user bonuses.
\n","auth":{"type":"basic","basic":{"password":"Required -
\nActive Session of the User
Required -
\nActive Session of the User
Required
\n","type":"text/plain"},"key":"userID","value":"4543929"},{"description":{"content":"Required -
\n 1 - SmartBonus, 2 - ProfitBonus, 3 - BalanceBonus, 4 - StickyBonus, 5 - NoDepositBonus
Required -
Required -
\nRelated deposit amount
Required
\n","type":"text/plain"},"key":"factor","value":"20"}],"variable":[]}},"response":[{"id":"5c902e77-7913-4e33-8824-b381bcbd129e","name":"Create Bonus","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/bonus/create?session=abe41b407946c43d4c230f4d55bd6584&userID=4543929&type=2&amount=150&deposit=300&factor=20","host":["https://platform-api.backpack.io"],"path":["bonus","create"],"query":[{"key":"session","value":"abe41b407946c43d4c230f4d55bd6584","description":"Required -Required -
\nActive Session of the User
Required - Can be retrived by \"User Bonuses\" Call
\n","type":"text/plain"},"key":"bonusID","value":"33894"}],"variable":[]}},"response":[{"id":"b669c58d-a963-4cb8-87f0-2988ecd4e60c","name":"Cancel Bonus","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/bonus/cancel?session=abe41b407946c43d4c230f4d55bd6584&bonusID=33894","host":["https://platform-api.backpack.io"],"path":["bonus","cancel"],"query":[{"key":"session","value":"abe41b407946c43d4c230f4d55bd6584","description":"Required -The bonus module is used to create,
\ncancel and retrieve information about user bonuses.
\nBonus types:
\n1 - SmartBonus, 2 - ProfitBonus, 3 - BalanceBonus, 4 - StickyBonus,
\n5 - NoDepositBonusBonus
\nFactors (defaults, can be configured per site){
\n \"1\": [
\n { \"from\": 0, \"to\": 10, \"factor\": 15 },
\n { \"from\": 11, \"to\": 25, \"factor\": 20 },
\n { \"from\": 25, \"to\": 35, \"factor\": 25 },
\n { \"from\": 36, \"to\": 50, \"factor\": 30 }
\n ],
\n \"2\": [
\n { \"from\": 0, \"to\": 25, \"factor\": 15 },
\n { \"from\": 26, \"to\": 50, \"factor\": 20 },
\n { \"from\": 51, \"to\": 100, \"factor\": 30 },
\n { \"from\": 101, \"to\": 150, \"factor\": 35 }
\n ],
\n \"3\": [
\n { \"from\": 0, \"to\": 25, \"factor\": 15 },
\n { \"from\": 26, \"to\": 50, \"factor\": 20 },
\n { \"from\": 51, \"to\": 100, \"factor\": 30 },
\n { \"from\": 101, \"to\": 200, \"factor\": 35 },
\n { \"from\": 201, \"to\": 300, \"factor\": 40 }
\n ],
\n \"4\": [
\n { \"from\": 0, \"to\": 100, \"factor\": 10 }
\n ],
\n \"5\": [
\n { \"max\": 100, \"factor\": 10 }
\n ]
\n}
Step 1 of 4 - deposit initiation
\nResponse : Record ID
\n","auth":{"type":"basic","basic":{"password":"Required -
Active Session of the User
Required -
Original amount of the deposit
Required -
Actual amount To Credit after Convertion rate
Required -
currency to credit
Required -
Convertion rate to USD/XXX
Required -
Name of the Gateway /PSP
Required -
walletID to credit
Required -
wallet Type to credit
1=Options , 3=FX , 5=MT5
Step 2 of 4 - checking user wallet response for pending payment
\n","auth":{"type":"basic","basic":{"password":"Required -
Active Session of the User
Required -
Record Id that Rerives from \"Create Charge\" Call
Step 3 of 4 - updating current status for the deposit attempt
\n","auth":{"type":"basic","basic":{"password":"Required -
Active Session of the User
Required -
Record Id that Rerives from \"Create Charge\" Call
Required -
0=created, 1=pending, 2=approved, 3=declined
Step 4 of 4 - Update User balance
\n ++ Should be used only on Approved deposits! ++
Required -
Active Session of the User
Required -
Record Id that Rerives from \"Create Charge\" Call
Required -
Actual amount To Credit after Convertion rate
Required -
walletID to credit
Required -
wallet Type to credit
1=Options , 3=FX , 5=MT5
Required
\n","type":"text/plain"},"key":"gateway","value":"PS"},{"description":{"content":"Optional -
\n0= None, 1=Sends Confirmation Emeil
The Deposit module is used to make a deposit via API
\nthe call is in 4 steps and should be treated as 1 process.
Each call will provide a response that is essential to the execution of the following call.
\nMake sure to follow the steps accordingly to complete payment process.
Required
\n","type":"text/plain"},"key":"userID","value":"4901207"}],"variable":[]}},"response":[{"id":"cd5f7adc-cbc1-4a0c-a011-bbcbfb7eafa5","name":"Delete Account Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://platform-api.backpack.io/account/delete-account-request?userID=4901207","host":["https://platform-api.backpack.io"],"path":["account","delete-account-request"],"query":[{"key":"userID","value":"4901207","description":"Required "}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Accept-Ranges","value":"bytes","name":"Accept-Ranges","description":"Content-Types that are acceptable"},{"key":"Age","value":"0","name":"Age","description":"The age the object has been in a proxy cache in seconds"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"103","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/html; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 08 Aug 2018 14:29:01 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache","name":"Server","description":"A name for the server"},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"Via","value":"1.1 varnish","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Cache","value":"MISS","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"platform-api.tradesmarter.com","path":"/","secure":false,"value":"phoi54oqrqcmgohc9miu7g12i2","key":"PHPSESSID"}],"responseTime":null,"body":"{\"success\":true,\"message\":\"The request to delete your account received\",\"deleteRequestID\":\"465\"}"}],"_postman_id":"ddcf9b34-963e-4b61-9e1b-e6fdcf018357"},{"name":"Update Delete Account Request","id":"31caa824-276c-4a8e-9738-a7eb2bdccd53","request":{"method":"GET","header":[],"url":"https://platform-api.backpack.io/account/update-delete-account-request?userID=4901207&deleteRequestID=465&status=4","auth":{"type":"basic","basic":{"password":"Required
\n","type":"text/plain"},"key":"userID","value":"4901207"},{"description":{"content":"Required
Retrived from \"Delete Account Request\" Call
Required - 1=Requested, 2=FollowedUp ,
\n3=Declined, 4=Approved (Confirming request) , 5 =Deleted
In case of errors,
\nthe response header will be 500,
\nand the response body will be formatted as follows:{
\nsuccess: false,
\nerror: {
\ncode: The error code,
\nmessage: The error message
\n}
\n}
1 - General error.
\n10 - Email already exists.
\n11 - Missing parameters.
\n20 - Could not log in Please verify that you're using the correct email and password.
\n21 - Email not found.
\n30 - Login required.
\n40 - Confirmation Error incorrect token / user is not confirmed.
\n100 - User is blocked.
\n101 - User is frozen.
\n104 - Invalid facebook user.
\n105 - Invalid site ID.
\n106 - Some parameters are not correct.
\n206 - Feed problems.
\n Trade could not be accepted Please refresh the page and try again.
\n340 - technical error.
\n341 - Invalid parameters.
Wallet Related Errors:
\n114 - Wallet ID and Platform ID mismatch.
\n342 - Max deposit.
Trade Related Errors
\n200 - Incorrect payout.
\n201 - Incorrect stake - Invalid investment amount.
\n Amount should be between [min] and [max].
\n203 - User stake is too high.
\n You have exceeded your investment limit for this option.
\n212 - leverage not in range.
\n344 - Volume traded technical error.
\n345 - Volume inactive.
\n346 - Volume not found.
Bonus Related Errors:
\n343, 348 - Invalid factor.
Withdrawal Related Errors:
\n103 - Not enough funds to perform withdrawal.
\n380 - Withdrawal – technical error.
\n381 - Withdrawal – empty.
\n382 - Withdrawal – reserved.
\n383 - Withdrawal – locked.
\n384 - Withdrawal – not found.
\n385 - Withdrawal – Reject by active bonus.