{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9d10e398-0ee6-4a59-877f-3c1e789a0859","name":"Client API (ClientSandbox)","description":"**{{Company}} Client APIs (v1.0)**\n\n## Introduction\n\n{{Company}}'s API environment gives Client’s access to {{Company}} services though a standardized interface. This platform provides an isolated development (sandbox) environment that allows the Client to test features, run experiments, and use “fake” money to test custom configurations without impacting the Client’s production environment.\n\nAs well, Clients can access an API production environment where they can manage their customers and perform various actions on their customer base such as bill payments, e-Transfers, etc.\n\n## Getting Started!\n\n{{Company}}’s API environment is based on REST technology and authorizes requests using a JWT Bearer Token sent and encrypted via HTTPS `{{stableVersion}}`.\n\n**Note:** Although there are multiple avenues to test and utilize {{Company}} API’s, {{Company}} uses the universal tool [Postman](https://www.getpostman.com/) and recommends it for Client testing.\n\nTo gain access to {{Company}}’s API environment, do the following:\n\n1. Select an authentication method as outlined in the “Authorization” section of this guide.\n    \n2. Determine the environment type: A) Sandbox or B) Production.\n    \n3. Fill out the form located at [https://www.dcbank.ca/get-started](https://www.dcbank.ca/get-started) (Please allow 24-hour response time: M-F 8am-5pm MST).\n    \n    **Note:** The Client will receive an email from {{Company}} with API security credentials.\n    \n4. Acquire the Bearer Token. To use any {{Company}} API’s, Client’s are required to first acquire a Bearer Token by posting the Client’s API Security Credentials via HTTPS to the Login endpoint: `{{docsBaseUrl}}/integrationapi/v1.0/Authentication/Login`\n    \n    **Note:** The Bearer Token must then be supplied to all other endpoint requests via an authorization header. E.g. `Authorization: Bearer`\n    \n5. For any questions or issues regarding the APIs please contact [apisupport@dcbank.ca](https://null)\n    \n\n## Authorization\n\nTo maintain the security of the Client’s applications and users, all requests to {{Company}} API’s must be authenticated using standards such as OAuth 2.0 and JSON Web Tokens (JWT). The JWT is then used along with Client-specific information to generate the Client’s personal access token.\n\n{{Company}}’s API environment supports two methods of authentication:\n\n1. **Username and Password** – An invitation email is sent to the Client by {{Company}}. This email will contain a username and temporary password (valid for 1 day).\n    \n    **Note:** On receipt of the email, the Client must change the password by using the Change Password API.\n    \n2. **Token** – No username and password are employed in the testing process. A {{Company}} IT specialist will contact the Client directly (via email) to provide the token information.\n    \n\n## Authentication Token Expiry\n\nWhen a token expires, Clients can request a re-issue by sending an email to {{Support}}.\n\n## Endpoints\n\nThe Client API is accessed via requests to a specific versioned endpoint URL which is sent and encrypted through HTTPS. Each Client API version will be made available with different endpoint URLs.\n\nThe current stable endpoint URL for the Client APIs is: `{{docsBaseUrl}}/integrationapi/{{stableVersion}}`\n\n## Login Endpoint URL\n\n`{{docsBaseUrl}}/integrationapi/{{stableVersion}}/Authentication/Login`\n\n## Handling the Authorization Response\n\nIf the response is successful you will receive a JSON object containing a Bearer Token, which you can then use for all other endpoint requests. Please see the **Login Endpoint URL** for detailed Success and Error responses.\n\n## Required Headers\n\nAll of the Client API endpoints must contain the following headers, unless otherwise noted:\n\n| Header | Value | Notes |\n| --- | --- | --- |\n| Content-Type | application/json |  |\n| Authorization | Bearer | Not required for the **Login Endpoint URL**. |\n\n## API Format\n\n| JSON | Example Using Camel Case |\n| --- | --- |\n| String | { \"name\" : \"johnDoh\"} |\n| Number | {\"age\" : 30} |\n| Object | {\"name\" : \\[\"name\" : \"John\", \"Age\" : 30, \"city : \"newYork\"\\]} |\n| Array | {\"employees\" : \\[\"John\", \"anna\", \"Peter\"\\]} |\n| Boolean | { \"sale\" : true} |\n| Null | {\"middlename\" : null} |\n\n## Request Body _(text/json)_\n\n`{ \"username\": \"\", \"password\": \"\" }`\n\n## Request Methods\n\n| APIs | Description |\n| --- | --- |\n| GET | Retrieves a resource |\n| POST | Creates a resource |\n| PUT | Updates or creates within an existing resource |\n| PATCH | Partially modifies an existing resource |\n| DELETE | Removes the resource |\n\n## Request Body Parameters\n\n| Type | Description |\n| --- | --- |\n| Header Parameters | Parameters included in the request header, usually related to authorization |\n| Path Parameters | Parameters within the path of the endpoint, before the query string. These are set off within curly braces |\n| Query String Parameters | Parameters in the query string of the endpoint, after the path parameter |\n\n## Error Codes\n\n| Code | Description |\n| --- | --- |\n| 200 - Ok | Everything worked as expected |\n| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter |\n| 401 - Unauthorized | No valid API key provided |\n| 402 - Request Failed | The parameters were valid but the request failed |\n| 403 - Forbidden | The API key doesn't have permission to perform the request |\n| 404 - Not Found | The requested resource does not exist |\n| 409 - Conflict | The request conflicts with another request |\n| 429 - Too many requests | Too many requests hit the API too quickly |\n| 500, 502, 503, 504 - Service Errors | Something went wrong on {{Company}}'s end |\n\n## Versioning\n\nAs new versions are implemented, a change log will be posted including instruction on how to upgrade the version.\n\n| API | Version Supported | Date Released | Description | End of Life Date |\n| --- | --- | --- | --- | --- |\n| All | v1.0 | 2020-04-01 | Initial release |  |\n| CreateEtransferTransaction | v1.1 | 2020-11-17 | Available for only CreateEtransferTransaction |  |\n\n## Help and Support?\n\nPlease feel free to contact {{Company}}'s Technical Support team anytime via email to {{Support}}. \\* Please allow one business day for a turn around time.\n\n## Frequently Asked Questions (FAQs)\n\n<li><div>Q. Do you have separate tokens or endpoints for testing (where no real money is transferred) vs. production?</div></li>\n\n<p>a) Yes, there is a testing token available. To obtain this token, send an email request to {{Support}}.</p>\n\n<li><div>Q. Do you need Client domains/IPs for an allow list like your SFTP service?</div></li>\n\n<p>a) Yes, {{Company}} requires the Client’s IPs once ready to move to production. There is no whitelisting for UAT.</p>\n\n<li><div>Q. What is the UAT API base URL?</div></li>\n\n<p>a) {{docsStagingBaseUrl}}</p>\n\n<li><div>Q. Are the money values real in {{Company}}’s Client API Sandbox environment?</div></li>\n\n<p>a) No, {{Company}}’s Client API sandbox environment uses “phony” or “fake” monetary values.</p>\n\n## API Template\n\nEach API is based on the following template. Please copy and paste and use for each new API created.\n\n#### Description\n\nEntered a detailed description of the API.\n\n#### Request Parameters\n\n| Name | Type | Max Length | Description | Required/Optional |\n| --- | --- | --- | --- | --- |\n|  |  |  |  |  |\n\n#### Related Errors\n\n| Error Code | Description |\n| --- | --- |\n|  |  |\n\n#### Version\n\n| Version Supported | Date Released | End of Life Date |\n| --- | --- | --- |\n| v1.0 | December 2019 | TBD |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10757426","collectionId":"9d10e398-0ee6-4a59-877f-3c1e789a0859","publishedId":"SzYUa25q","public":true,"publicUrl":"https://clientdoc.dcbankapi.com","privateUrl":"https://go.postman.co/documentation/10757426-9d10e398-0ee6-4a59-877f-3c1e789a0859","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2B5BD4"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2B5BD4"}}]}},"version":"8.10.1","publishDate":"2024-10-07T20:21:09.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"DOCUMENTATION_DCB_Values","id":"58143d33-229b-43ad-b27e-b5b561741a9b","owner":"21177784","values":[{"key":"docsBaseUrl","value":"https://clientprod.dcbankapi.com","enabled":true,"type":"default"},{"key":"docsStagingBaseUrl","value":"https://mrcapisandbox.dcbank.ca","enabled":true,"type":"default"},{"key":"Company","value":"DCBank","enabled":true,"type":"default"},{"key":"Support","value":"apisupport@dcbank.ca","enabled":true,"type":"default"},{"key":"Contact","value":"https://www.dcbank.ca/get-started","enabled":true,"type":"default"},{"key":"stableVersion","value":"V1.0","enabled":true,"type":"default"}],"published":true}],"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://dcbankapi.com/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"},{"label":"DOCUMENTATION_DCB_Values","value":"21177784-58143d33-229b-43ad-b27e-b5b561741a9b"}],"canonicalUrl":"https://clientdoc.dcbankapi.com/view/metadata/SzYUa25q"}