{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7ea400a9-6dce-41ff-9d51-a56c222e9652","name":"BoardingAPI Development Guide","description":"The BridgePay Gateway Boarding API allows a reseller partner to automate the merchant onboarding process to reduce the overall time to receive live gateway credentials and begin merchant processing.\n\nThis API provides the ability to create and manage organizations/accounts and related users under the Reseller organization/account structure. The structure will include users at each organization/account level and is organized in a parent-child relational hierarchy.\n\n# Authentication\n\nEach call to the Boarding API requires credentials. The Credentials object is used as a property of other objects in the API. The Credentials Object contains two properties:\n\n**UserName** and **Password**.\n\nBoth properties are strings.\n\nThe `Credentials` object is required on all API calls and follows this format:\n\n```\n{\n    \"Credentials\": {\n        \"UserName\": \"A Valid Username\",\n        \"Password\": \"A Valid Password\"\n    }\n}\n\n ```\n\n# Common Model\n\nThe **CommonModel** object is used by methods that do not require more complex structures in order to complete their function. For example, whereas **saving** an organization requires that the user send a complete Organization model, **retrieving** an Organization only requires the user’s credentials and the ID of the Organization being retrieved. Therefore, the CommonModel object was created to support these functions.\n\n## CommonModel Object Properties\n\n| Property Name | Type | Notes |\n| --- | --- | --- |\n| Id | Integer | Used when retrieving a model that has an ID field. |\n| ReferenceCode | Integer | Reserved for Future Use. |\n| ProfileType | String | Used when retrieving the Processor Profile Model Dictionary. |\n| Credentials | Credentials | The Credentials Object. |\n\n# Response Model\n\nEach call to the API uses a common wrapper around the response object that is returned. This wrapper is called the **ResponseModel**. The ResponseModel object contains the following properties:\n\n| Property Name | Type | Notes |\n| --- | --- | --- |\n| MissingFields | List | This property is an array of strings that identify any fields that were missing in the request that caused the request to fail. For example, calling GetOrganization without the OrganizationID will result in a failed request and this property will contain “OrganizationID” in the list, indicating that it was missing. |\n| InvalidFields | List | This property is an array of strings that identify fields that failed validation and caused the request to fail. For example: Sending invalid credentials will cause the request to fail and this property will contain “Credentials” in the list, indicating that the credentials failed validation. |\n| Messages | List | This property is an array of strings that provides more detailed information about the success or failure of the request. For example, when trying to retrieve an Organization using GetOrganization, if the ID requested does not exist in the database, the ID will be represented in the **InvalidFields** property since the ID was invalid, and the Messages property will contain a string saying, “Invalid Organization Id” as a means to provide more information about the failure. |\n| Success | Boolean | Indicates whether the request succeeded or not. |\n| Id | String | If the requested action affected one particular record, this field contains the ID of the record affected by the method called. For example, if the user requested to Deactivate an Organization, the ID field in the ResponseModel would be the ID of the Organization that was deactivated. |\n| ReturnObjectType | Varies | This polymorphic object contains the object that was requested via the method. For example, if the user requested an Organization, this ReturnObject property will contain the Organization object they intended to retrieve. |\n| PageSize | Integer | The number of objects to return on methods that return list objects, mirrored back in response, if not provided on request a default of 25 is returned. |\n| Page | Integer | Zero based page number, e.g. if 300 total objects were returned based on request, using a PageSize Default of 25, Pages would be 0 through 11. |\n| Total | Integer | Total number of objects that are returned based on request. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12042629","team":1219657,"collectionId":"7ea400a9-6dce-41ff-9d51-a56c222e9652","publishedId":"2s9YJZ34K9","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12042629/2s9YJZ34K9","privateUrl":"https://go.postman.co/documentation/12042629-7ea400a9-6dce-41ff-9d51-a56c222e9652","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"336699"},"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":"336699"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"336699"}}]}},"version":"8.12.3","publishDate":"2023-10-11T16:26:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/e5fb6ed8c548bf3f1cc6971574661cb025bee04fefd07aea28c05c1ea5d7fc10","favicon":"https://res.cloudinary.com/postman/image/upload/v1603909092/team/cladybj2atahj6748oqd.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://documenter.gw.postman.com/view/metadata/2s9YJZ34K9"}