{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2d064307-12bc-4671-99d5-eca1600f5a8b","name":"GRG API v1.8 - 2022-10-24","description":"# Welcome!\n\nThe Global Reach API is designed for customers who want to get direct access to their GRG account and take advantage of our transactional FX, risk management and international payments platform. There are many potential applications, but our vision is to expose the GRG toolbox and allow integrators to make use of our capabilities however they best suit you.\n\nWe are on a journey to expose the best of our capabilities and will be regularly rolling out enhancements and new features.\n\nWe have two environments - Sandbox and Production.\n\nIn Sandbox, no trades or payments will be executed in the market, so it is completely safe to experiment. We recommend you never enter production credentials into Postman.\n\n## Changes in this release\n\n\\*   Standalone payments from available trades balance and from trades with available balance\n    \n\n## Getting Started\n\nInternally at GRG, we make extensive use of Postman and felt it was the best way to give integrators the interactive documentation and tooling that makes for an easy onboarding process.\n\nWe highly recommend that you use Postman to make your way through the Bootcamp list in the Platform API section of the documentation. If you want to dive straight into using curl to test things out on the command line, or build a test app outside of Postman, then we recommend using the code generator inside Postman to get you going.\n\nSimple choose each endpoint in turn then click on the < /> icon to reveal the code generator panel. This will help you get all the right headers and encodings straight off the bat.\n\n**Step 1 - Sign up for a GRG account**.\n\nYou will need to have a registered GRG account before you can begin testing and investigating the API.\n\n**Step 2 - Request access to the API from your dealer**\n\nOnce you have requested access, we will configure your API account and provide the necessary credentials via a secure method.\n\n**Step 3 - Try it out in Postman**\n\nEnter your credentials into the Environments section in Postman, and begin exploring!\n\nWe heavily recommend you never use your production environment credentials in Postman. It will potentially compromise the security of your account and any trades you book or payments you make will _actually be processed_ and require funding.\n\n## Common Terms\n\n\\*   Client Id and Client Secret - The API access credentials that provide access to underlying client accounts.\n\\*   Client account – A unique account for a given on-boarded entity. All eg beneficiaries, trades, payments etc reside under one client account and are not shared with other client accounts.\n\\*   Account ID - A unique 6-9 digit client identifier for each client account.\n\\*   Beneficiary – recipient of funds\n\\*   Payment - outgoing cashflow to a beneficiary\n\\*   Settlement - incoming cashflow to GRG eg to pay for a trade.\n    \n\n#### Credentials & Accounts Hierarchy\n\nAt GRG, each individual or entity has a Client Account. Beneficiaries, trades and payments are scoped to a single Client Account.\n\nIn the example below, a single set of API credentials (client_id, client_secret) can access multiple client accounts. This is usual in a group structure, or for a partner managing a number of clients:\n\n\\*   Client id A (API Access Credentials)\n    \\*   Client Account 1\n        \\*   Client 1 - Beneficiaries\n        \\*   Client 1 - Trades\n        \\*   Client 1 - Payments\n    \\*   Client Account 2\n        \\*   Client 2 - Beneficiaries\n        \\*   Client 2 - Trades\n        \\*   Client 2 - Payments\n\n## Auth API and Platform API\n\nWithin Postman, we have two distinct folders representing two separate APIs:\n\n\\*   Auth API\n\\*   Platform API\n    \n\nThe Auth API folder relates to our central auth server API for obtaining JWTs for use with the Platform API.\n\nThe Platform API folder is where our GRG API lives, and may have different requirements, request and response formats to the Auth API.\n\n## Postman Automation\n\nWithin Postman, we have made use of pre-request and test scripts as well as environment and collection level variables to make your first experiences of the journey simpler to understand. When it comes to integrating into your own platform, you will be more directly responsible for setting the correct headers, getting valid JWT tokens etc.\n\nUsing the code generator can simplify the task of understanding what details are required.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"21839173","collectionId":"2d064307-12bc-4671-99d5-eca1600f5a8b","publishedId":"2s84LJ1Ehe","public":true,"publicUrl":"https://postman.grg-api.net","privateUrl":"https://go.postman.co/documentation/21839173-2d064307-12bc-4671-99d5-eca1600f5a8b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-10-24T10:05:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://grg-api.net/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://postman.grg-api.net/view/metadata/2s84LJ1Ehe"}