{"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.

This 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.

Authentication

Each 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:

UserName and Password.

Both properties are strings.

The Credentials object is required on all API calls and follows this format:

{\n    \"Credentials\": {\n        \"UserName\": \"A Valid Username\",\n        \"Password\": \"A Valid Password\"\n    }\n}\n\n

Common Model

The 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.

CommonModel Object Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Id	Integer	Used when retrieving a model that has an ID field.
ReferenceCode	Integer	Reserved for Future Use.
ProfileType	String	Used when retrieving the Processor Profile Model Dictionary.
Credentials	Credentials	The Credentials Object.

Response Model

Each 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
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.
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.
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.
Success	Boolean	Indicates whether the request succeeded or not.
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.
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.
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.
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.
Total	Integer	Total number of objects that are returned based on request.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Common Model","slug":"common-model"},{"content":"Response Model","slug":"response-model"}],"owner":"12042629","collectionId":"7ea400a9-6dce-41ff-9d51-a56c222e9652","publishedId":"2s9YJZ34K9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"336699"},"publishDate":"2023-10-11T16:26:45.000Z"},"item":[{"name":"Organization, Hierarchy, and User overview","item":[{"name":"QuickStart - Required calls","item":[{"name":"1. Create a Merchant Group","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG OrgId: \" + jsonData.Id, true);\r"," pm.collectionVariables.set(\"MerchantGroupId\", jsonData.Id);\r","} else {\r"," pm.test(\"Check MG Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"78fdbbf0-3d32-4fb4-912d-cfcf4740fb01"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"96f238f0-d4f0-463c-9612-c6bc317e24fb"}}],"id":"1b328a14-7ed9-4644-8238-f3421c1227b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI Merchant Group\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 4,\r\n \"ParentId\": OrgId for Reseller,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantGroupOrg\",\r\n \"ContactLastName\": \"ForReseller\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

The Merchant Group is above the Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"f6f58e7b-1e3b-47d2-a88c-c779e423fff6","name":"Create a Merchant Group","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI Merchant Group\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 4,\r\n \"ParentId\": OrgId for Reseller,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantGroupOrg\",\r\n \"ContactLastName\": \"ForReseller\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:06:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ExampleMerchantGroupId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"1b328a14-7ed9-4644-8238-f3421c1227b6"},{"name":"2. Create a Merchant Account","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"MerchantAccountId\", jsonData.Id);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MA OrgId: \" + jsonData.Id, true);\r"," pm.collectionVariables.set(\"MerchantAccountId\", jsonData.Id);\r","} else {\r"," pm.test(\"Check MA Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"dea2b93e-ec80-4cb0-b46d-460c68b1a56c"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"d0473ebe-1bbb-4a57-bab0-304796395e75"}}],"id":"293d526d-3d5c-48b1-b56d-e20c985bd989","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BapiDocMerchantAccount\",\r\n \"AddressLine1\": \"129 99th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"BapiDocMerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

The Merchant Account is used for processing the payment.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9bad88a3-b244-42e3-b89b-4f218d18fee1","name":"Create a Merchant Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BapiDocMerchantAccount\",\r\n \"AddressLine1\": \"129 99th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"BapiDocMerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:10:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ExampleMerchantAccountId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"293d526d-3d5c-48b1-b56d-e20c985bd989"},{"name":"3. Create a Merchant Group User","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG UserId: \" + jsonData.Id, true);\r","} else {\r"," pm.test(\"Check MG User Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"0e1dd819-908f-4ace-aa68-9e77c5e3f260"}}],"id":"ce6d579b-a8cb-4ca0-a967-ea9ce9277088","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserName\",\r\n \"FirstName\": \"MGAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 4,\r\n \"RoleId\": Use GetRoles,\r\n \"OrganizationId\": ExampleMerchantGroupId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser","description":"

User and Password for the Merchant Group.

User and Password for Payment Processing.

MyBridgePay Virtual Terminal setup.

Setup settlement time, duplicate checking, etc.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateGatewayConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"3b179eda-cb9c-49e4-8774-48ae6de96d97","name":"Create the Gateway Configuration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"SettlementType\": \"Daily\",\r\n \"SettlementCutoff\": 2000,\r\n \"SettlementDelay\": 0,\r\n \"WalletSiteId\": null,\r\n \"BatchEmailNotification\": true,\r\n \"IsDuplicateCheckOnAuthEnabled\": false,\r\n \"IsDuplicateCheckOnSaleEnabled\": false,\r\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\r\n \"DuplicateCheckTimeRange\": 20,\r\n \"BatchEmailAddresses\" : [\r\n \"emailForSettlement@bridgepaynetwork.com\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateGatewayConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:20:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [\n \"GatewayConfiguration created for OrganizationId ExampleMerchantAccountId\"\n ],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"49c0011f-9e1f-4c10-9782-889d54fda5c8"},{"name":"7. Create a Processing Profile for BridgePay Test Processor","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"2054abf4-ad97-4e89-947e-a27b8b9e28a8"}},{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.test(\"ProfileId: \" + jsonData.Id, true);"],"type":"text/javascript","id":"7f3603ee-bd6a-4d4b-8366-e59393df9458"}}],"id":"592ff97a-6702-4cac-8939-91a695626a22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n\t\"OrganizationId\": ExampleMerchantAccountId,\r\n\t\"IsActive\": true,\r\n\t\"Type\": \"cards-realtime/proxy\",\r\n\t\"DataElements\": [\r\n\t\t{\r\n\t\t\t\"Name\": \"IsAmountRangesEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsCreditEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsConvenienceFeeEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsTokenizationRequired\",\r\n\t\t\t\"Value\": \"False\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"AccountProcessingPolicy\",\r\n\t\t\t\"Value\": \"VMXDN---\",\r\n\t\t\t\"DataType\": \"String\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Setup/select processor.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"222989f5-bb4a-4cb1-977e-929d3a8571f7","name":"Create a Processing Profile for BridgePay Test Processor","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n\t\"OrganizationId\": ExampleMerchantAccountId,\r\n\t\"IsActive\": true,\r\n\t\"Type\": \"cards-realtime/proxy\",\r\n\t\"DataElements\": [\r\n\t\t{\r\n\t\t\t\"Name\": \"IsAmountRangesEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsCreditEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsConvenienceFeeEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsTokenizationRequired\",\r\n\t\t\t\"Value\": \"False\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"AccountProcessingPolicy\",\r\n\t\t\t\"Value\": \"VMXDN---\",\r\n\t\t\t\"DataType\": \"String\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:20:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"cards-realtime/proxy\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"592ff97a-6702-4cac-8939-91a695626a22"}],"id":"1996c7e6-3cbd-4ec6-8754-aa3de58a23e2","description":"

Required steps for setting up an account.

These are the minimum steps required to board an account to do transactions.

\n","_postman_id":"1996c7e6-3cbd-4ec6-8754-aa3de58a23e2"},{"name":"Example Merchant Group with Merchant Account","item":[{"name":"Create a Merchant Group","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG OrgId: \" + jsonData.Id, true);\r"," pm.collectionVariables.set(\"MerchantGroupId\", jsonData.Id);\r","} else {\r"," pm.test(\"Check MG Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"02bae415-5378-4cc8-9fed-1e354c78ca31"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"a0cb6b57-11a8-49a5-8d5b-51c20264c601"}}],"id":"440478d2-aad2-47b3-8025-53b4f0880560","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI Merchant Group\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 4,\r\n \"ParentId\": OrgId for Reseller,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantGroupOrg\",\r\n \"ContactLastName\": \"ForReseller\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

Within the Reseller Organization, a new Merchant Group is created. The ParentId is known for the reseller and the OrganizationTypeId for the Merchant Group level is obtained by using the GetOrganizationTypes call.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"ba988cfa-28a5-4ea4-afbe-7745b378d4f1","name":"Create a Merchant Group","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI Merchant Group\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 4,\r\n \"ParentId\": OrgId for Reseller,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantGroupOrg\",\r\n \"ContactLastName\": \"ForReseller\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:06:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ExampleMerchantGroupId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"440478d2-aad2-47b3-8025-53b4f0880560"},{"name":"Create a Merchant Account","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"MerchantAccountId\", jsonData.Id);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MA OrgId: \" + jsonData.Id, true);\r"," pm.collectionVariables.set(\"MerchantAccountId\", jsonData.Id);\r","} else {\r"," pm.test(\"Check MA Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"bdd7018b-392d-4a78-a71a-43d5e0a6f20e"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"c1f7e430-528e-4544-a9b5-65fde4e428e2"}}],"id":"375d7377-d65c-4c07-931f-3caa37867cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BapiDocMerchantAccount\",\r\n \"AddressLine1\": \"129 99th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"BapiDocMerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

Within the newly created Merchant Group Organization, a new Merchant Account is created. The ParentId is obtained from the response on the Merchant Group creation and the OrganizationTypeId for the Merchant Account level is obtained by using the GetOrganizationTypes call.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"d56083bb-1eb4-4238-a32e-c445acb60bbe","name":"Create a Merchant Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BapiDocMerchantAccount\",\r\n \"AddressLine1\": \"129 99th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"BapiDocMerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:10:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ExampleMerchantAccountId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"375d7377-d65c-4c07-931f-3caa37867cbf"},{"name":"Create a Merchant Group User","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG UserId: \" + jsonData.Id, true);\r","} else {\r"," pm.test(\"Check MG User Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"aec6bca4-f1d6-40bc-80f6-6a1c9aada0e6"}}],"id":"16513095-068d-4c48-9cc9-77d433d33639","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserName\",\r\n \"FirstName\": \"MGAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 4,\r\n \"RoleId\": Use GetRoles,\r\n \"OrganizationId\": ExampleMerchantGroupId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser","description":"

Within the newly created Merchant Group Organization, a new Merchant Group user is created. The ParentId is obtained from the response of the Merchant Group creation. The UserType for the Merchant Group level is obtained by using GetUserTypes and the RoleId obtained by using GetRoles.

Within the newly created Merchant Account Organization, a new Merchant Account user is created. The ParentId is obtained from the response of the Merchant Account creation. The UserType for the Merchant Account level is obtained by using GetUserTypes and the RoleId obtained by using GetRoles.

An application config is created for the Merchant Account. the MyBridgePay VT is created in this case, which would allow a user with access to the Merchant Account and the correct Role right to use the virtual terminal to be able to process transactions on MyBridgePay.

To view other potential Application configurations one could create, use the GetApplications call.

A gateway configuration is created for the Merchant Account.

For more information about the gateway configuration, see the Gateway Configuration section.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateGatewayConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"a46135e6-96dd-43c0-8fed-6055a0e517bf","name":"Create the Gateway Configuration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"SettlementType\": \"Daily\",\r\n \"SettlementCutoff\": 2000,\r\n \"SettlementDelay\": 0,\r\n \"WalletSiteId\": null,\r\n \"BatchEmailNotification\": true,\r\n \"IsDuplicateCheckOnAuthEnabled\": false,\r\n \"IsDuplicateCheckOnSaleEnabled\": false,\r\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\r\n \"DuplicateCheckTimeRange\": 20,\r\n \"BatchEmailAddresses\" : [\r\n \"emailForSettlement@bridgepaynetwork.com\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateGatewayConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:20:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [\n \"GatewayConfiguration created for OrganizationId ExampleMerchantAccountId\"\n ],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"8d244c1c-fd56-43c6-a44a-4c2cb4de7955"},{"name":"Create a Processing Profile for BridgePay Test Processor","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"922074b8-54be-4084-824b-40b72df88057"}},{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.test(\"ProfileId: \" + jsonData.Id, true);"],"type":"text/javascript","id":"4c13a4b9-8de6-4b65-b309-a3fe53d892b6"}}],"id":"4116be82-b13d-4cf9-bfbc-ea93384ea3b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n\t\"OrganizationId\": ExampleMerchantAccountId,\r\n\t\"IsActive\": true,\r\n\t\"Type\": \"cards-realtime/proxy\",\r\n\t\"DataElements\": [\r\n\t\t{\r\n\t\t\t\"Name\": \"IsAmountRangesEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsCreditEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsConvenienceFeeEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsTokenizationRequired\",\r\n\t\t\t\"Value\": \"False\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"AccountProcessingPolicy\",\r\n\t\t\t\"Value\": \"VMXDN---\",\r\n\t\t\t\"DataType\": \"String\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Within the newly created Merchant Account Organization, a Processor Profile is created.

The OrganizationId is obtained from the response on the Merchant Account creation.
The Type for the Proxy Profile is obtained using GetProfileTypes.
The necessary DataElements for the Proxy Profile is obtained using GetProfileDictionary.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0ca98e25-9a1f-4d22-a1fa-c8989130b466","name":"Create a Processing Profile for BridgePay Test Processor","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n\t\"OrganizationId\": ExampleMerchantAccountId,\r\n\t\"IsActive\": true,\r\n\t\"Type\": \"cards-realtime/proxy\",\r\n\t\"DataElements\": [\r\n\t\t{\r\n\t\t\t\"Name\": \"IsAmountRangesEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsCreditEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsConvenienceFeeEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsTokenizationRequired\",\r\n\t\t\t\"Value\": \"False\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"AccountProcessingPolicy\",\r\n\t\t\t\"Value\": \"VMXDN---\",\r\n\t\t\t\"DataType\": \"String\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:20:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"cards-realtime/proxy\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"4116be82-b13d-4cf9-bfbc-ea93384ea3b2"}],"id":"3e823c37-e2ef-4764-be80-dbf8695abbb3","description":"

Below is an example of creating a Merchant Group, creating a Merchant Account, and configuring that Merchant Account for processing credit cards.

The hierarchy would be as follows:

Reseller (existing) > Merchant Group (created) > Merchant Account (created)

Reseller
- Merchant Group (with Merchant Group User)
  - Merchant Account (with Merchant Account User)
    - Application Configuration for MyBridgePay VT (Virtual Terminal)
    - Gateway Configuration
    - Processor Profile for Proxy
    \n
  \n
\n

\n","_postman_id":"3e823c37-e2ef-4764-be80-dbf8695abbb3"},{"name":"Example Sales Agent with Merchant Account","item":[{"name":"Create a Sales Agent","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG OrgId: \" + jsonData.Id, true);\r"," pm.collectionVariables.set(\"MerchantGroupId\", jsonData.Id);\r","} else {\r"," pm.test(\"Check MG Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"a53ded6a-91ad-4961-8094-862520fb4a2a"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"805c0969-4afb-4eed-9151-122f231ff80e"}}],"id":"496fa41c-ebce-4a0e-a372-62c8331e4a13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI Merchant Sales Agent\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 3,\r\n \"ParentId\": OrgId for Reseller,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"SalesAgentOrg\",\r\n \"ContactLastName\": \"ForReseller\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

Within the Reseller Organization, a new Sales Account is created. The ParentId is known for the reseller and the OrganizationTypeId for the Sales Agent level is obtained by using the GetOrganizationTypes call.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"496fa41c-ebce-4a0e-a372-62c8331e4a13"},{"name":"Create a Sales Agent User","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG UserId: \" + jsonData.Id, true);\r","} else {\r"," pm.test(\"Check MG User Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"729f920d-7a9e-4549-a602-81624e3ecf1a"}}],"id":"6f2efa1b-c199-4595-8856-ae1305f6cbd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserName\",\r\n \"FirstName\": \"SAAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 3,\r\n \"RoleId\": Use GetRoles,\r\n \"OrganizationId\": OrgId for SalesAgent\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser","description":"

Within the newly created Sales Agent Organization, a new Sales Agent user is created. The ParentId is obtained from the response of the Sales Agent creation. The UserType for the Sales Agent level is obtained by using GetUserTypes and the RoleId obtained by using GetRoles.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f2efa1b-c199-4595-8856-ae1305f6cbd5"},{"name":"Create a Merchant Group","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG OrgId: \" + jsonData.Id, true);\r"," pm.collectionVariables.set(\"MerchantGroupId\", jsonData.Id);\r","} else {\r"," pm.test(\"Check MG Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"3dc1682d-edfb-4de4-a13b-a5b192224823"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"50edb534-3696-40e7-86f7-41b7e99dd3fb"}}],"id":"82d7339a-984a-4614-9c1c-2278afb12682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI Merchant Group\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 4,\r\n \"ParentId\": OrgId for SalesAgent,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantGroupOrg\",\r\n \"ContactLastName\": \"ForSalesAgent\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

Within the Sales Agent Organization, a new Merchant Group is created. The ParentId is known for the Sales Agent that was created and the OrganizationTypeId for the Merchant Group level is obtained by using the GetOrganizationTypes call.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9cfd8ca1-ff10-4cef-a8d5-3f62f9813f30","name":"Create a Merchant Group","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI Merchant Group\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 4,\r\n \"ParentId\": OrgId for Reseller,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantGroupOrg\",\r\n \"ContactLastName\": \"ForReseller\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:06:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ExampleMerchantGroupId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"82d7339a-984a-4614-9c1c-2278afb12682"},{"name":"Create a Merchant Group User","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MG UserId: \" + jsonData.Id, true);\r","} else {\r"," pm.test(\"Check MG User Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"1dd31fa9-5546-4e6f-8919-56e3586aeaea"}}],"id":"0b2ee349-5e88-4612-9c01-fd56fcf14c9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"DesiredUserName\",\r\n \"FirstName\": \"MGAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 4,\r\n \"RoleId\": Use GetRoles,\r\n \"OrganizationId\": ExampleMerchantGroupId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser","description":"

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"2d34b833-dd0a-4491-81cb-b9fe6d8439e5","name":"Create a Merchant Group User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"DesiredUserName\",\r\n \"FirstName\": \"MGAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 4,\r\n \"RoleId\": Use GetRoles,\r\n \"OrganizationId\": ExampleMerchantGroupId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:08:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ID of User\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"0b2ee349-5e88-4612-9c01-fd56fcf14c9a"},{"name":"Create a Merchant Account","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"MerchantAccountId\", jsonData.Id);\r","\r","if (jsonData.Id) {\r"," pm.test(\"MA OrgId: \" + jsonData.Id, true);\r"," pm.collectionVariables.set(\"MerchantAccountId\", jsonData.Id);\r","} else {\r"," pm.test(\"Check MA Creation\", function () {\r"," pm.expect.fail();\r"," });\r","}"],"type":"text/javascript","id":"021fd420-9341-4b56-b043-03214327ca52"}},{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"6c14983f-7696-4ea4-bbb9-e21f69b0d12b"}}],"id":"27aca1b8-f458-45f9-845a-aa9464073bdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BapiDocMerchantAccount\",\r\n \"AddressLine1\": \"129 99th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"BapiDocMerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"1758c777-8ad3-4642-9313-9c7cc595a45e","name":"Create a Merchant Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BapiDocMerchantAccount\",\r\n \"AddressLine1\": \"129 99th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"BapiDocMerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:10:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ExampleMerchantAccountId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"27aca1b8-f458-45f9-845a-aa9464073bdf"},{"name":"Create a Merchant Account User","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.test(\"MA UserId: \" + jsonData.Id, true);"],"type":"text/javascript","id":"e5856a7d-4f54-4adb-9e0f-c956b7554d6a"}}],"id":"4bcdf441-9f00-4909-a83d-0edc5a632d14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserName\",\r\n \"FirstName\": \"MerchantAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 5,\r\n \"RoleId\": Use GetRoles,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser","description":"

To view other potential Application configurations one could create, use the GetApplications call.

A gateway configuration is created for the Merchant Account.

For more information about the gateway configuration, see the Gateway Configuration section.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateGatewayConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"99bf1d18-dbef-4245-81a5-86960bcec7b0","name":"Create the Gateway Configuration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"SettlementType\": \"Daily\",\r\n \"SettlementCutoff\": 2000,\r\n \"SettlementDelay\": 0,\r\n \"WalletSiteId\": null,\r\n \"BatchEmailNotification\": true,\r\n \"IsDuplicateCheckOnAuthEnabled\": false,\r\n \"IsDuplicateCheckOnSaleEnabled\": false,\r\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\r\n \"DuplicateCheckTimeRange\": 20,\r\n \"BatchEmailAddresses\" : [\r\n \"emailForSettlement@bridgepaynetwork.com\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateGatewayConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 14:20:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [\n \"GatewayConfiguration created for OrganizationId ExampleMerchantAccountId\"\n ],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"760e0082-a451-45b7-9306-8f0ca0f8fc9e"},{"name":"Create a Processing Profile for BridgePay Test Processor","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"ee4efa95-829e-4856-b971-068816992104"}},{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.test(\"ProfileId: \" + jsonData.Id, true);"],"type":"text/javascript","id":"4447771e-8bed-408e-891c-1ec00426c571"}}],"id":"7e288e02-c3b8-407d-95cd-c644d3d789aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n\t\"OrganizationId\": ExampleMerchantAccountId,\r\n\t\"IsActive\": true,\r\n\t\"Type\": \"cards-realtime/proxy\",\r\n\t\"DataElements\": [\r\n\t\t{\r\n\t\t\t\"Name\": \"IsAmountRangesEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsCreditEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsConvenienceFeeEnabled\",\r\n\t\t\t\"Value\": \"True\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"IsTokenizationRequired\",\r\n\t\t\t\"Value\": \"False\",\r\n\t\t\t\"DataType\": \"Boolean\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Name\": \"AccountProcessingPolicy\",\r\n\t\t\t\"Value\": \"VMXDN---\",\r\n\t\t\t\"DataType\": \"String\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Within the newly created Merchant Account Organization, a Processor Profile is created.

Below is an example of creating a Sales Agent, creating a Merchant Group, creating a Merchant Account, and configuring that Merchant Account for processing credit cards.

The hierarchy would be as follows:

Reseller (existing) > Sales Agent (created) > Merchant Group (created) > Merchant Account (created)

Reseller

Sales Agent
- Merchant Group (with Merchant Group User)
  - Merchant Account (with Merchant Account User)
    - Application Configuration for MyBridgePay VT
    - Gateway Configuration
    - Processor Profile for Proxy
    \n
  \n
\n

\n","_postman_id":"e15a54be-832b-4f4f-9798-157eb2072e39"}],"id":"df2bb964-e6da-4f69-857d-27e8a9912d79","description":"

Organizations represent all the different levels of accounts that can exist. They use a parent to child model. Users belong to a given organization and can have roles and rights within that organizations hierarchy.

Reseller is the highest level of organization of the gateway, followed by an optional Sales Agent level, which ultimately leads to Merchant Groups and Merchant Accounts.

Merchant Accounts are the entities where processor boarding information is added.

This relationship is represented as follows which allows for the following complex relationships, plan ahead to meet your unique business needs.

Reseller > Merchant Group > Merchant Account

Reseller
- Merchant Group 1
  \n
  - Merchant Account 1
    \n
  - Merchant Account 2
    \n
  - Merchant Account 3
    \n
  \n
- Merchant Group 2
  \n
  - Merchant Account 1
    \n
  - Merchant Account 2
    \n
  \n
- Merchant Group 3
  \n
  - Merchant Account 1
    \n
  - Merchant Account 2
    \n
  \n
\n

Reseller > Sales Agent > Merchant Group > Merchant Account

Reseller
- Sales Agent A
  \n
  - Merchant Group 1
    \n
    - Merchant Account 1
      \n
    - Merchant Account 2
      \n
    - Merchant Account 3
      \n
    \n
  - Merchant Group 2
    \n
    - Merchant Account 1
      \n
    - Merchant Account 2
      \n
    \n
  \n
- Sales Agent B
  \n
  - Merchant Group 1
    - Merchant Account 1
    \n
  \n
\n

When creating an organization, the information you provide follows a standard model regardless of the level in the hierarchy. To control which level the organization resides, provide an OrganizationTypeId and a ParentId.

The OrganizationID and ParentID work in a hierarchical
sense, and they can’t be replaced. The ParentID always refers to the
OrganizationID of the value above it in the hierarchy.

For example:

When
working on the Group level, the ParentID is the OrganizationID for the
Reseller
\n
When
working on the Account level, the ParentID is the OrganizationID for the
Group
\n
When
creating User accounts for the Account, the OrganizationID is the Merchant
Accounts OrganizationID
\n

The users created at each organization can have roles assigned to them for the appropriate access.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3e0214cd-a148-4dfd-871a-b56fdb30fe32"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"12ff316e-2942-402c-a620-4f1973b850e2"}}],"_postman_id":"df2bb964-e6da-4f69-857d-27e8a9912d79"},{"name":"Organization Management","item":[{"name":"GetOrganizationTypes","id":"9b4dbca4-a5eb-42b6-819b-a41cb54ec5c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Credentials\": {\n \"UserName\": \"valid user name\",\n \"Password\": \"valid password\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganizationTypes","description":"

Using this method will return the OrganizationTypeModel. This is where you get the Id that is used in the OrganizationTypeId field on the CreateOrganization call:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Organization Types	Description
1	Gateway	This level is for future use. Do not use.
2	Reseller	Reseller Organizations can only be created by BridgePay.
3	Sales Agent	Exists under a Reseller organization/account. Can create and manage all organizations/accounts and users within its own hierarchy structure consisting of Merchant Groups and associated Merchant Accounts.
4	Merchant Group	Exists under a Reseller organization/account or under a Sales Agent organization/account hierarchy structure. Can manage users under its own Merchant Group and associated Merchant Accounts.
5	Merchant Account	Exists under a Reseller organization/account or under a Sales Agent organization/account hierarchy structure. The Merchant Group organization/account is its direct parent account relationship.

OrganizationTypeModel

The OrganizationTypeModel object describes an Organization. Each Organization has an OrganizationType. The properties of an OrganizationType are as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
CreatedDate	DateTime	The date and time the type was created.
Id	Integer	The ID of the Organization Type.
LastUpdateDate	DateTime	The date and time the type was last modified.
LastUpdatedBy	String	The user that last updated the type.
Name	String	The friendly display name of the Organization Type.
OrganizationLevel	Integer	The numeric level (0 being highest) of the Organization.
SubGroupLevel	Integer	The numeric level within the OrganizationLevel (0 being highest).

OrganizationType Hierarchy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Organization Type	Level	Sublevel
Gateway	0	0
Reseller	1	0
Sales Agent	1	1
Merchant Group	2	0
Merchant Account	3	0

Level/Sublevel Explanation

An Organization of a given type can be a child of another organization under certain rules. In order to be a child of another organization, the Parent’s Organization Type must be in the next higher Level or Sublevel than the child. Therefore, a Merchant Group can be a child of a Sales Agent or a Reseller because the Merchant Group’s level is 2 and the Sales Agent and Reseller’s Levels are 1.

Even though both Reseller and Sales Agents are both at Level 1, a Sales Agent can be a child of a Reseller because its sublevel is 1 and the Reseller’s Sublevel is 0.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetOrganizationTypes"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"61269f69-66b0-4c47-91d6-66c11876677d","name":"GetOrganizationTypes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Credentials\": {\n \"UserName\": \"valid user name\",\n \"Password\": \"valid password\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganizationTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 20:30:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Id\": 1,\n \"Name\": \"Gateway\",\n \"OrganizationLevel\": 0,\n \"SubGroupLevel\": 0,\n \"CreatedDate\": \"2019-09-17T15:35:48.65\",\n \"LastUpdateDate\": \"2019-09-17T15:35:48.65\",\n \"LastUpdatedBy\": \"sys\"\n },\n {\n \"Id\": 2,\n \"Name\": \"Reseller\",\n \"OrganizationLevel\": 1,\n \"SubGroupLevel\": 0,\n \"CreatedDate\": \"2019-09-17T15:35:48.65\",\n \"LastUpdateDate\": \"2019-09-17T15:35:48.65\",\n \"LastUpdatedBy\": \"sys\"\n },\n {\n \"Id\": 3,\n \"Name\": \"Sales Agent\",\n \"OrganizationLevel\": 1,\n \"SubGroupLevel\": 1,\n \"CreatedDate\": \"2019-09-17T15:35:48.667\",\n \"LastUpdateDate\": \"2019-09-17T15:35:48.667\",\n \"LastUpdatedBy\": \"sys\"\n },\n {\n \"Id\": 4,\n \"Name\": \"Merchant Group\",\n \"OrganizationLevel\": 2,\n \"SubGroupLevel\": 0,\n \"CreatedDate\": \"2019-09-17T15:35:48.667\",\n \"LastUpdateDate\": \"2019-09-17T15:35:48.667\",\n \"LastUpdatedBy\": \"sys\"\n },\n {\n \"Id\": 5,\n \"Name\": \"Merchant Account\",\n \"OrganizationLevel\": 3,\n \"SubGroupLevel\": 0,\n \"CreatedDate\": \"2019-09-17T15:35:48.683\",\n \"LastUpdateDate\": \"2019-09-17T15:35:48.683\",\n \"LastUpdatedBy\": \"sys\"\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List OrganizationTypes\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"9b4dbca4-a5eb-42b6-819b-a41cb54ec5c1"},{"name":"CreateOrganization","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.test(jsonData.Id, true);"],"type":"text/javascript","id":"ba89f558-a883-4282-a5a3-57562acd970e"}}],"id":"249cacd2-d354-44ec-b223-516b4b921e73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI MerchantAccount99\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"CountryCode\": \"US\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization","description":"

Using this call, you can create a new Organization. Organization can be at the different levels as defined in OrganizationTypes

The address data for this request supports American and Canadian addresses.

OrganizationModel

Property Name	Required	Type	Min	Max	Notes
Name	Yes	String	2	50	The name of the Organization.
AddressLine1	Yes	String	2	100	The address of the Organization.
AddressLine2	No	Nullable String	2	100	Additional address info.
AddressLine3	No	Nullable String	2	100	Additional address info.
City	Yes	String	2	25	The city of the Organization.
State	Yes	String	2	2	The state of the Organization.
PostalCode	Yes	String	5	10	The zip code.
CountryCode	Yes	String	2	2	The country code.
EmailAddress	Yes	String	5	100	Primary contact e-mail address.
PhoneNumber	Yes	String	2	15	Primary contact phone number.
OrganizationTypeId	Yes	Integer	1	15	The Organization Type ID (see GetOrganizationTypes).
ParentId	Yes	Nullable Integer	1	15	The Organization ID of the parent of this Organization.
Id	Response Only	Integer	1	15	The unique ID of the Organization.
CreateDate	Response Only	Nullable DateTime	19	23	The date and time the record was created.
LastUpdated	Response Only	Nullable DateTime	19	23	The date and time the record was last modified.
LastModifiedBy	Response Only	Nullable String	2	50	The user who last modified the record.
DeactivateDate	Response Only	Nullable DateTime	0	23	The date and time the Organization was deactivated.
IsActive	Yes	Boolean	4	5	Indicates if the Organization is active.
Notes	No	Nullable String	0	255
TimeZone	Yes	String	7	15	Time zone data. The following values are accepted by the API: EST5EDT CST6CDT MST7MDT PST8PDT NST3:30NDT AST4ADT EST5EDT CST6CDT MST7MDT PST8PDT Australia/Sydney Australia/Darwin Australia/Perth NZ NZ-CHAT AST4ADT HAST10HADT AKST9AKDT
Credentials	Yes	Credentials Object			Only used for Create/Update/Get.

","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"3b53ab46-39ec-4796-9b4a-ee3c28b85dd9","name":"Create a Merchant Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI MerchantAccount\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 5,\r\n \"ParentId\": Example ParentId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantAccount\",\r\n \"ContactLastName\": \"ForMG\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 21:21:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"Example OrgId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"},{"id":"4fc69fc0-00a9-4728-a051-463ff975ef33","name":"Create a Merchant Group Account within the Reseller","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Name\": \"BAPI MerchantGroupAccount\",\r\n \"AddressLine1\": \"129 5th Street\",\r\n \"City\": \"Rockledge\",\r\n \"State\": \"FL\",\r\n \"PostalCode\": \"32927\",\r\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\r\n \"PhoneNumber\": \"1234560790\",\r\n \"OrganizationTypeId\": 4,\r\n \"ParentId\": Example ParentId,\r\n \"IsActive\": true,\r\n \"Notes\": \"Created by Boarding API\",\r\n \"TimeZone\": \"EST5EDT\",\r\n \"ContactFirstName\": \"MerchantGroup\",\r\n \"ContactLastName\": \"ForReseller\",\r\n \"IsVisible\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 21:05:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"Example OrgId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"249cacd2-d354-44ec-b223-516b4b921e73"},{"name":"UpdateOrganization","id":"2e9e730c-eeee-4afd-ac62-0a9fedfb62f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantAccountId,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"PhoneNumber\": \"8675309999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateOrganization","description":"

Purpose: Allows the user to modify Sales Agent, Merchant Group, or Merchant Account organizations. Uses the same Organization Model as CreateOrganization but the only required fields are Credentials, ID, ParentID, and whichever fields are being updated.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","UpdateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9b7806e2-df56-4093-9175-3baccfcee87b","name":"Update Merchant Account Phone Number","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantAccountId,\r\n \"ParentId\": ExampleMerchantGroupId,\r\n \"PhoneNumber\": \"8675309999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Aug 2020 12:51:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"LBCS=!+JrRYwksEPGd+aKv48J3YuPMJapPiiN80HKD9c9YKG6bOnUDQb/jztGY0160SQ+CA7+7Tb5XCug52x4=; path=/; Httponly; Secure"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"2e9e730c-eeee-4afd-ac62-0a9fedfb62f1"},{"name":"ActivateOrganization","id":"9f3d939f-075d-4b0c-b0dd-bd37cbdeafba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateOrganization","description":"

Allows the user to activate an Organization that was deactivated.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","ActivateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"5ced456b-aefb-43de-941a-7d5e1925b6f8","name":"Activating a Deactivated Merchant Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Aug 2020 14:54:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ExampleMerchantAccountId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"9f3d939f-075d-4b0c-b0dd-bd37cbdeafba"},{"name":"DeactivateOrganization","id":"79f7e89e-a555-4da9-a5fa-6cc83e7f57a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateOrganization","description":"

Allows the user to deactivate an Organization.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","DeactivateOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9357512e-d272-4294-9f5c-2f2aa227cb62","name":"ActivateOrganization","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": OrgId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Aug 2020 14:54:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"OrgId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"},{"id":"bab03c81-d8a9-4362-959e-8bd77736fb5a","name":"DeactivateOrganization","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": OrgId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Aug 2020 14:56:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"79f7e89e-a555-4da9-a5fa-6cc83e7f57a5"},{"name":"GetOrganizations","event":[{"listen":"prerequest","script":{"id":"c02a2e85-a58f-41f4-913f-f9d4d768da9e","exec":[""],"type":"text/javascript"}}],"id":"b6056b11-d858-415d-a6b9-16d692b9db84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ParentId\": Example OrgId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganizations","description":"

Using this call, the user can retrieve Organizations that match the provided filter.

This call does not display data for custom fields. For Custom Field data, use GetOrganization.

Note: PageSize default is 25. If a total number of Organizations returned for the filter is greater than 25, either get the additional pages or increase the PageSize

OrganizationFilterModel

Property Name	Required	Type	Min	Max	Notes
Credentials	Yes	Credentials Object			Only used for Create/Update/Get.
ParentId	No	Nullable Integer	1	15	The Organization ID of the parent, e.g. a Merchant Group provided here would cause all Merchant Accounts to be returned for that Organization.
Name	No	String	2	300	The name of the Organization.
City	No	String	2	25	The city of the Organization.
State	No	String	2	2	The state of the Organization.
PostalCode	No	String	5	10	The zip code.
Email	No	String	5	100	Primary contact e-mail address.
CountryCode	No	String	2	2	The country code.
PhoneNumber	No	String	5	100	Primary contact phone number.
TimeZone	No	String	7	15	Time zone data (see Time Zones).
IsActive	No	Boolean	4	5	Indicates if the Organization is active.
OrganizationTypeId	No	Integer	1	15	The Organization Type ID (see GetOrganizationTypes).
SortBy	No	List			Sort by a specific Organization field, see below.
PageSize	No	Integer	1	4	Maximum number of Organizations to return. Default if not provided is 25.
Page	No	Integer	1	4	Page Number to return, zero based page number, e.g. if 300 total objects were returned based on filter, using a PageSize Default of 25, Pages would be 0 through 11.

SortBy
The returned list of Organizations can be sorted with one of the following OrganizationModel fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Fields	.	.	.
Id	Name	AddressLine1	AddressLine2
AddressLine3	City	State	PostalCode
CountryCode	EmailAddress	PhoneNumber	GatewayObjectId
OrganizationTypeId	ParentId	CreateDate	LastUpdated
LastModifiedBy	DeactivateDate	IsActive	Notes
TimeZone	ContactFirstName	ContactLastName	ContactPersonalPhone
ContactMobilePhone	IsVisible

ReturnObject in ResponseModel: List OrganizationModel containing the list of organizations for the filter provided.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetOrganizations"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"1e873865-1270-4d97-b987-dfcd5b484574","name":"GetOrganizations","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ParentId\": Example OrgId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganizations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:00:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Credentials\": null,\n \"Id\": Example OrgId,\n \"Name\": \"BAPI MerchantAccount\",\n \"AddressLine1\": \"129 5th Street\",\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": \"Rockledge\",\n \"State\": \"FL\",\n \"PostalCode\": \"32927\",\n \"CountryCode\": null,\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\n \"PhoneNumber\": \"1234560790\",\n \"GatewayObjectId\": 12445001,\n \"OrganizationTypeId\": 5,\n \"ParentId\": Example OrgId,\n \"CreateDate\": \"2020-08-03T17:05:04.917\",\n \"LastUpdated\": \"2020-08-03T17:21:37.02\",\n \"LastModifiedBy\": \"bapireselleruser\",\n \"DeactivateDate\": null,\n \"IsActive\": true,\n \"Notes\": \"Created by Boarding API\",\n \"TimeZone\": \"EST5EDT\",\n \"ContactFirstName\": \"MerchantAccount\",\n \"ContactLastName\": \"ForMG\",\n \"ContactPersonalPhone\": null,\n \"ContactMobilePhone\": null,\n \"IsVisible\": false,\n \"OwnedCustomFields\": null,\n \"ActivatedCustomFields\": null,\n \"ServiceConfigurations\": null\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List OrganizationModel\",\n \"PageSize\": 25,\n \"Page\": 0,\n \"Total\": 1\n}"}],"_postman_id":"b6056b11-d858-415d-a6b9-16d692b9db84"},{"name":"GetOrganization","id":"16ece65a-8efb-40d3-be32-a04507907d9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantGroupId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganization","description":"

Using this call, you can find info for a specific Organization.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetOrganization"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0310e5c0-f180-4b49-8522-06c405d2eb9d","name":"GetOrganization for Reseller","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": OrgId for Reseller\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganization"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 20:54:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"Id\": OrgId,\n \"Name\": \"BAPI ResellerLevelExample\",\n \"AddressLine1\": \"123 5th Street\",\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": \"Rockledge\",\n \"State\": \"FL\",\n \"PostalCode\": \"32927\",\n \"CountryCode\": null,\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\n \"PhoneNumber\": \"1234560790\",\n \"GatewayObjectId\": 5661,\n \"OrganizationTypeId\": 2,\n \"ParentId\": null,\n \"CreateDate\": \"2020-08-03T16:44:39.49\",\n \"LastUpdated\": \"2020-08-03T16:44:39.49\",\n \"LastModifiedBy\": \"wwebber\",\n \"DeactivateDate\": null,\n \"IsActive\": true,\n \"Notes\": \"Created by Boarding API\",\n \"TimeZone\": \"EST5EDT\",\n \"ContactFirstName\": \"Reseller\",\n \"ContactLastName\": \"Level\",\n \"ContactPersonalPhone\": null,\n \"ContactMobilePhone\": null,\n \"IsVisible\": false,\n \"OwnedCustomFields\": [],\n \"ActivatedCustomFields\": [],\n \"ServiceConfigurations\": []\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"OrganizationModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"16ece65a-8efb-40d3-be32-a04507907d9a"}],"id":"bfc7f81b-679a-42c2-9c7b-787c0276e304","description":"

This section describes how to create and manage organization/accounts with the Boarding interface. Applicable organization/account options are: Sales Agent, Merchant Group, and Merchant Account.

Note that there are a maximum of 999 Merchant Accounts allowed in a single merchant group. Exceeding the maximum number of Merchant Accounts will result in an error.

\n","_postman_id":"bfc7f81b-679a-42c2-9c7b-787c0276e304"},{"name":"Merchant Account Organization Specifics","item":[{"name":"Application Configuration","item":[{"name":"GetApplications","id":"7d64fa65-3ee5-4ec1-9191-fa51a38bef9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetApplications","description":"

Purpose: Allows the user to retrieve a list of Applications that are supported when adding a Processing Application to a Merchant Account Organization. More information about Merchant Account organization is in the Merchant Account specific section.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetApplications"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"e6858267-30fb-43bc-9638-b8f6fe7b359b","name":"GetApplications","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetApplications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 13:58:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n \"WebLINK\",\n \"SOAP\",\n \"MyBridgepay VT\",\n \"MyBridgepay VT EMV\",\n \"TokenPay\"\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List string\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"7d64fa65-3ee5-4ec1-9191-fa51a38bef9e"},{"name":"GetApplicationConfigs","id":"c53447f0-d66b-42fe-9147-ba86b241dcf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetApplicationConfigs","description":"

Allows the user to get a list of Application configurations enabled for a specific Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetApplicationConfigs"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"db574d8f-68d4-43ec-b227-bf5ffe332d36","name":"GetApplicationConfigs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": 8451\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetApplicationConfigs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:04:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Credentials\": null,\n \"Id\": \"B264FF1E-C8C1-4EBE-8EAE-03A6F8C60691\",\n \"Application\": \"SOAP\",\n \"CaptureType\": \"Client\",\n \"OrganizationId\": 8451,\n \"ClientCode\": \"RE\"\n },\n {\n \"Credentials\": null,\n \"Id\": \"ADB734E9-7A04-434C-B5D8-38317E49C9AB\",\n \"Application\": \"MyBridgepay VT\",\n \"CaptureType\": \"Client\",\n \"OrganizationId\": 8451,\n \"ClientCode\": \"RE\"\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List ApplicationConfigModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"c53447f0-d66b-42fe-9147-ba86b241dcf5"},{"name":"GetApplicationConfig","id":"8ed7ef36-55c4-4496-b5c1-887d0f6a84cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \"ADB734E9-7A04-434C-B5D8-38317E49C9AB\",\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetApplicationConfig","description":"

Allows the user to get a specific Application configuration by its ID for a specific Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetApplicationConfig"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"5a409c30-7ef1-4782-900c-b420b880fb2b","name":"GetApplicationConfig","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \"ADB734E9-7A04-434C-B5D8-38317E49C9AB\",\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetApplicationConfig"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"Id\": \"ADB734E9-7A04-434C-B5D8-38317E49C9AB\",\n \"Application\": \"MyBridgepay VT\",\n \"CaptureType\": \"Client\",\n \"OrganizationId\": 12345,\n \"ClientCode\": \"RE\"\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ApplicationConfigModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"8ed7ef36-55c4-4496-b5c1-887d0f6a84cf"},{"name":"CreateApplicationConfig","id":"80240859-33ae-4752-86fe-d362c8029e39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Application\": \"MyBridgepay VT\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"ClientCode\": \"RE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateApplicationConfig","description":"

Allows the user to create an Application configuration for a specific Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateApplicationConfig"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"5fe09822-7fc2-4152-a22c-d96f7049dece","name":"CreateApplicationConfig for SOAP","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Application\": \"SOAP\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": 8451,\r\n \"ClientCode\": \"RE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateApplicationConfig"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:00:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"B264FF1E-C8C1-4EBE-8EAE-03A6F8C60691\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"},{"id":"35eeed6b-fde6-4c82-8bc7-25908e2266e2","name":"CreateApplicationConfig for VT","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Application\": \"MyBridgepay VT\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": 8451,\r\n \"ClientCode\": \"RE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateApplicationConfig"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:03:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ADB734E9-7A04-434C-B5D8-38317E49C9AB\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"},{"id":"c0b315e6-2677-4f8f-bdc6-bc89eaaaf1bf","name":"CreateApplicationConfig for TokenPay","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Application\": \"TokenPay\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"ClientCode\": \"RE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateApplicationConfig"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Mar 2021 18:09:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Set-Cookie","value":"LBCS=!ueB47BXoM+1g02b8FeO44uEu+pUMSU3L/az5iNRC+5Ei1+pN1ZDK7LrwJvToE7vRMU1M590gVXqED5g=; path=/; Httponly; Secure"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"8997A9CF-3709-4315-B675-155DF77005BA\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"80240859-33ae-4752-86fe-d362c8029e39"},{"name":"UpdateApplicationConfig","id":"1f0491e2-e02b-4a6d-ad02-6642a5905754","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \"ADB734E9-7A04-434C-B5D8-38317E49C9AB\",\r\n \"Application\": \"MyBridgepay VT\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"ClientCode\": \"EC\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateApplicationConfig","description":"

Allows the user to update an existing Application configurations for a specific Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","UpdateApplicationConfig"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"f8d7fe39-136e-4e54-bf41-5e2d6e8a7af4","name":"UpdateApplicationConfig","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \"ADB734E9-7A04-434C-B5D8-38317E49C9AB\",\r\n \"Application\": \"MyBridgepay VT\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"ClientCode\": \"EC\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateApplicationConfig"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"1f0491e2-e02b-4a6d-ad02-6642a5905754"},{"name":"ActivateApplicationConfig","id":"998dad9c-37b0-4449-a234-afe405226a05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Application\": \"MyBridgepay VT\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": 12345,\r\n \"ClientCode\": \"RE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateApplicationConfig","description":"

Allows the user to Activate an existing Application configurations for a specific Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","ActivateApplicationConfig"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0a2562c6-9651-447d-b925-6c3f35430fbe","name":"ActivateApplicationConfig","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Application\": \"MyBridgepay VT\",\r\n \"CaptureType\": \"Client\",\r\n \"OrganizationId\": 12345,\r\n \"ClientCode\": \"RE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateApplicationConfig"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"C7C811BF-FBCF-4BD9-1234-FEFD590A005B\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"998dad9c-37b0-4449-a234-afe405226a05"},{"name":"DeactivateApplicationConfig","id":"7548263d-c2e1-4e56-a07f-3095290db783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \"C7C811BF-FBCF-4BD9-1234-FEFD590A005B\",\r\n \"OrganizationId\": 12345\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateApplicationConfig","description":"

Allows the user to deactivate an Application configuration for a specific Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","DeactivateApplicationConfig"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"4e8791cd-7d3d-432a-8235-18cc48aa58c7","name":"DeactivateApplicationConfig","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \"C7C811BF-FBCF-4BD9-1234-FEFD590A005B\",\r\n \"OrganizationId\": 12345\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateApplicationConfig"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"7548263d-c2e1-4e56-a07f-3095290db783"}],"id":"1c607904-fc9a-4fda-ade4-31947dd56399","description":"

Describes how to retrieve, create, and update application configurations for a Merchant Account. Application config options include MyBridgePay VT, SOAP, SOAPX, WebLINK, etc…

\n","_postman_id":"1c607904-fc9a-4fda-ade4-31947dd56399"},{"name":"Gateway Configuration","item":[{"name":"CreateGatewayConfiguration","id":"5955b0c0-f952-4c17-8bfe-fd65ab0b6041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"SettlementType\": \"Daily\",\r\n \"SettlementCutoff\": 2000,\r\n \"SettlementDelay\": 0,\r\n \"WalletSiteId\": null,\r\n \"BatchEmailNotification\": true,\r\n \"IsDuplicateCheckOnAuthEnabled\": false,\r\n \"IsDuplicateCheckOnSaleEnabled\": false,\r\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\r\n \"DuplicateCheckTimeRange\": 20,\r\n \"BatchEmailAddresses\" : [\r\n \"emailForSettlement@bridgepaynetwork.com\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateGatewayConfiguration","description":"

Purpose: Allows the user to get the Gateway Configuration for the given Merchant Account organization ID.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateGatewayConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"7b6dc3b5-d0d0-425c-9200-7b2612b4f63f","name":"CreateGatewayConfiguration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"SettlementType\": \"Daily\",\r\n \"SettlementCutoff\": 2000,\r\n \"SettlementDelay\": 0,\r\n \"WalletSiteId\": null,\r\n \"BatchEmailNotification\": true,\r\n \"IsDuplicateCheckOnAuthEnabled\": false,\r\n \"IsDuplicateCheckOnSaleEnabled\": false,\r\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\r\n \"DuplicateCheckTimeRange\": 20,\r\n \"BatchEmailAddresses\" : [\r\n \"emailForSettlement@bridgepaynetwork.com\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateGatewayConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:09:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [\n \"GatewayConfiguration created for OrganizationId ExampleMerchantAccountId\"\n ],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"5955b0c0-f952-4c17-8bfe-fd65ab0b6041"},{"name":"GetGatewayConfiguration","id":"b1508e33-a605-4597-9fd4-2755c58f8f59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetGatewayConfiguration","description":"

Purpose: Allows the user to get the Gateway Configuration for the given merchant account organization ID.

GatewayConfigurationFilterModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Only used for Create/Update/Get.
OrganizationId	Integer	The Organization ID of the Merchant Account that has the Gateway Configuration in question.

","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetGatewayConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"ce27672a-29fc-4cfd-af3c-190e0c9fb5c9","name":"GetGatewayConfiguration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": 8451\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetGatewayConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:10:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"SettlementTypes\": [\n \"Manual\",\n \"Hourly\",\n \"Daily\"\n ],\n \"Credentials\": null,\n \"OrganizationId\": 8451,\n \"SettlementType\": \"daily\",\n \"SettlementCutoff\": 2000,\n \"SettlementDelay\": 0,\n \"WalletSiteId\": null,\n \"BatchEmailNotification\": true,\n \"AddCardNotPresent\": null,\n \"IsDuplicateCheckOnAuthEnabled\": false,\n \"IsDuplicateCheckOnSaleEnabled\": false,\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\n \"DuplicateCheckTimeRange\": 20,\n \"BatchEmailAddresses\": [\n \"emailForSettlement@bridgepaynetwork.com\"\n ]\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"GatewayConfigurationModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"b1508e33-a605-4597-9fd4-2755c58f8f59"},{"name":"UpdateGatewayConfiguration","id":"df20a12c-2fd2-414c-b9a9-9cc10af73fef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"SettlementType\": \"Daily\",\r\n \"SettlementCutoff\": 2000,\r\n \"SettlementDelay\": 0,\r\n \"WalletSiteId\": null,\r\n \"BatchEmailNotification\": null,\r\n \"IsDuplicateCheckOnAuthEnabled\": false,\r\n \"IsDuplicateCheckOnSaleEnabled\": false,\r\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\r\n \"DuplicateCheckTimeRange\": null,\r\n \"BatchEmailAddresses\" : [\r\n \"anotherEmailForSettlement@bridgepaynetwork.com\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateGatewayConfiguration","description":"

Allows the user to Update an existing GatewayConfiguration

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","UpdateGatewayConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"a4a42e2c-1f0d-47f6-b514-ac0421bfd437","name":"UpdateGatewayConfiguration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"SettlementType\": \"Daily\",\r\n \"SettlementCutoff\": 2000,\r\n \"SettlementDelay\": 0,\r\n \"WalletSiteId\": null,\r\n \"BatchEmailNotification\": null,\r\n \"IsDuplicateCheckOnAuthEnabled\": false,\r\n \"IsDuplicateCheckOnSaleEnabled\": false,\r\n \"IsDuplicateCheckOnInvoiceNumberEnabled\": false,\r\n \"DuplicateCheckTimeRange\": null,\r\n \"BatchEmailAddresses\" : [\r\n \"anotherEmailForSettlement@bridgepaynetwork.com\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateGatewayConfiguration"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [\n \"GatewayConfiguration updated for OrganizationId 12345\"\n ],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"df20a12c-2fd2-414c-b9a9-9cc10af73fef"}],"id":"83585007-99a5-445b-92f4-1937f6a68e35","description":"

The GatewayConfiguration is where various features for a Merchant Account are stored. Each Merchant Account must have one Gateway Configuration.

The object uses the GatewayConfigurationModel as described below.

GatewayConfigurationModel

Property Name	Required	Type	Min	Max	Notes
SettlementTypes	Response Only	List			List of Settlement Types available, e.g. - Manual, Hourly, Daily.
Credentials	Yes	Credentials			Only used for Create/Update/Get.
OrganizationId	Yes	Integer	1	15	The Organization ID of the Merchant Account that has the Gateway Configuration in question.
SettlementType	Yes	String	5	6	Set Settlement Type.
SettlementCutoff	Yes	Integer	4	4	Time Eastern in 24HR, eg. 8:00 pm Eastern = 2000. Early hours values shoul not start with a \"0\" and just the last 3 digits, eg. 5:00 am Eastern = 500.
SettlementDelay	Yes	Integer	1	2	Time in minutes to delay settlement, eg. 0 = no delay, 30 is the maximum.
WalletSiteId	No	String (GUID)	36	36	Use the Site ID returned in Wallet API Site creation.
BatchEmailNotification	Yes	Boolean	4	5	Determines if a settlement email should be sent for merchant account.
AddCardNotPresent	Response Only	Null			No longer in use, to be removed in the future.
IsDuplicateCheckOnAuthEnabled	Yes	Boolean	4	5	Allows duplicate checking for Authorization Transactions for given range.
IsDuplicateCheckOnSaleEnabled	Yes	Boolean	4	5	Allows duplicate checking for sale transactions for given range.
IsDuplicateCheckOnInvoiceNumberEnabled	Yes	Boolean	4	5	Allows duplicate checking based on duplicate invoices for given range.
DuplicateCheckTimeRange	No	Integer	0	4	Ignored if all Duplicate Checks are set to false. If any Duplicate Checks are set to true and value is -1, then the entire batch is considered for Duplicate Checks. If set to 0 the entire date is considered. If 1-??, number of minutes that duplicate checking will be considered. Default value is 20, and maximum value is 2880. Eg. 20 = 20 minutes of duplicate checking for whichever Duplicate Check is set to true.
BatchEmailAddresses	No	List			List of emails that will receive Batch Email Notification if Batch Email Notification is set to true.

","_postman_id":"83585007-99a5-445b-92f4-1937f6a68e35"},{"name":"Processor Profile Management","item":[{"name":"GetProfileTypes","id":"3bec2d5f-103d-4081-a494-7f081ba06989","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfileTypes","description":"

Purpose: Allows the user to retrieve a list of Profile Types that are supported when adding a Processing Profile to a Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetProfileTypes"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"3ffd3e41-d52e-4834-95fd-66f502e29dbf","name":"GetProfileTypes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfileTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:15:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n \"ach-realtime/geti\",\n \"ach-realtime/profit-stars\",\n \"ach/keybank\",\n \"ach/proxy\",\n \"ach/t-tech\",\n \"ach/usag\",\n \"cards-realtime/authorize-net\",\n \"cards-realtime/elavon-viaconex4\",\n \"cards-realtime/firstdata-buypass\",\n \"cards-realtime/firstdata-nashville\",\n \"cards-realtime/firstdata-north\",\n \"cards-realtime/firstdata-omaha\",\n \"cards-realtime/firstdata-rapidconnect\",\n \"cards-realtime/globalpayments-east\",\n \"cards-realtime/heartland-exchange\",\n \"cards-realtime/heartland-portico\",\n \"cards-realtime/mastercard-mngs\",\n \"cards-realtime/mercurypay\",\n \"cards-realtime/paymenttech-chase\",\n \"cards-realtime/payvision\",\n \"cards-realtime/proxy\",\n \"cards-realtime/spindle\",\n \"cards-realtime/tabapay\",\n \"cards-realtime/trans-first\",\n \"cards-realtime/tsys\",\n \"cards-realtime/vantiv-tandem\",\n \"cards-realtime/worldpay\",\n \"debit-realtime/fiserv\",\n \"gift-realtime/pathwayLink/spk\",\n \"gift-realtime/pathwayLink/svs\",\n \"gift-realtime/pathwayLink/valutec\",\n \"gift-realtime/tendercard\",\n \"tokenization/strongauth\"\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List string\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"3bec2d5f-103d-4081-a494-7f081ba06989"},{"name":"GetProfileDictionary","id":"373ce037-6171-4e1a-bebe-11b77ca6296a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ProfileType\": \"cards-realtime/proxy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfileDictionary","description":"

Purpose: Allows the user to retrieve a list of data elements for a given Processor Profile Type.

ProfileDataElementModel

The ProfileDataElement Model is used only in the method GetProfileDictionary described below. It is only provided as a developer reference method to allow developers to retrieve the data elements for a Processing Profile.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
DefaultValue	String	Indicates what the default value is for the processor setting if none is provided.
EnumeratedValues	List	Provides a list of the acceptable values for the referenced field.
IsEnumerated	Boolean	Indicates that valid values for the referenced field has a limited number of valid values.
IsRequired	Boolean	Indicates whether or not the field is required.
MaxLength	Integer	Indicates the max length for the field.
MinLength	Integer	Indicates the min length for the field.
Name	String	Indicates the name of the field (to be provided during Processor Profile creation).
RegExPattern	String	Indicates the pattern used to validate the value of the field.

Usage Description

Calling the Get Profile Dictionary Method with a given profile name will return a collection of data elements that are required to create the Profile. Each Processor Profile is different containing different required parameters. The Boarding API provides a unified construct for sending Processor Profile information by using these data elements. Using the BridgePay Test Processor (or Proxy Processor) as an example, here is the method call to get the data elements needed to set up the Processor Profile.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetProfileDictionary"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"73ba1455-0f7d-48f3-9b0d-65e1efe9de54","name":"GetProfileDictionary","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ProfileType\": \"cards-realtime/proxy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfileDictionary"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"DataElements\": [\n {\n \"Name\": \"businessType\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 4,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"isQuasiCash\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": null,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"merchantAddress\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 38,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"merchantCity\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 21,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"merchantCountryCode\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 3,\n \"IsRequired\": false,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"merchantName\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 50,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"merchantPhoneNumber\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 14,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"merchantState\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 2,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"merchantZip\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 15,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"statementDescriptor\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 21,\n \"IsRequired\": false,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n },\n {\n \"Name\": \"username\",\n \"RegExPattern\": null,\n \"DefaultValue\": \"\",\n \"MinLength\": null,\n \"MaxLength\": 50,\n \"IsRequired\": true,\n \"IsEnumerated\": false,\n \"EnumeratedValues\": null\n }\n ],\n \"OrganizationId\": 0,\n \"ThresholdType\": \"credit\",\n \"SaleMaxSingleDollarAmount\": null,\n \"RefundMaxSingleDollarAmount\": 40,\n \"SaleRollingDollarVolume\": 20,\n \"RefundRollingDollarVolume\": 60,\n \"NotificationEmail1\": \"email@email.com\",\n \"NotificationEmail2\": \"email@email.com\"\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ProfileDictionaryModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"373ce037-6171-4e1a-bebe-11b77ca6296a"},{"name":"CreateProfile","id":"ef78d8f6-290e-47c7-860d-ac64e9090047","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/proxy\",\r\n \"ThresholdType\": \"credit\",\r\n \"SaleMaxSingleDollarAmount\": 420,\r\n \"RefundMaxSingleDollarAmount\": 1337,\r\n \"SaleRollingDollarVolume\": 0,\r\n \"RefundRollingDollarVolume\": 69,\r\n \"NotificationEmail1\": \"email@email.com\",\r\n \"NotificationEmail2\": \"email2@email.com\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"IsAmountRangesEnabled\",\r\n \"Value\": \"True\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"IsCreditEnabled\",\r\n \"Value\": \"True\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"IsConvenienceFeeEnabled\",\r\n \"Value\": \"True\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"IsTokenizationRequired\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"AccountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Purpose: Allows the user to create a Processor Profile. A Merchant Account can have more than one Processor Profile; however, only one Profile may be active for each ProfileType at a given time. If a profile is already created it can be modified with UpdateProfile. For more information for specific Data Elements for a given profile type see Appendix A3.

ProfileModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Only used for Create/Update/Get.
OrganizationId	Integer	The Organization ID of the Merchant Account.
IsActive	Nullable Boolean	Indicates if the Processor Profile is active or not.
Type	String	The ProfileType (see GetProfileTypes).
DataElements	Nullable list	List of the data elements and their values for this Profile.

DataElementModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Name	Nullable String	The name of the element.
Value	Nullable String	The value of the element.
DataType	Nullable String	The data type of the element for validation purposes.

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

Purpose: Allows the user to update a Processor Profile.

ProfileModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Only used for Create/Update/Get.
OrganizationId	Integer	The Organization ID of the Merchant Account.
IsActive	Nullable Boolean	Indicates if the Processor Profile is active or not.
Type	Nullable String	The ProfileType (see GetProfileTypes).
DataElements	Nullable list	List of the data elements and their values for this Profile.

DataElementModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Name	Nullable String	The name of the element.
Value	Nullable String	The value of the element.
DataType	Nullable String	The data type of the element for validation purposes.

Return ResponseModel with Success as true or false.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","UpdateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"8e530394-cee4-4ced-a9ea-d058c6155eed","name":"Update Proxy Profile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/proxy\",\r\n \"OrganizationId\": 8615,\r\n \"ThresholdType\": \"credit\",\r\n \"SaleMaxSingleDollarAmount\": 420,\r\n \"RefundMaxSingleDollarAmount\": 1337,\r\n \"SaleRollingDollarVolume\": 0,\r\n \"RefundRollingDollarVolume\": 69,\r\n \"NotificationEmail1\": \"email@email.com\",\r\n \"NotificationEmail2\": \"email2@email.com\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"IsAmountRangesEnabled\",\r\n \"Value\": \"True\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"IsCreditEnabled\",\r\n \"Value\": \"True\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"IsConvenienceFeeEnabled\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"IsTokenizationRequired\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"AccountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 16:25:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"32ba4da2-cd40-4587-9935-bb53841e4b99"},{"name":"ActivateProfile","id":"f47aa8fb-ca00-4439-a7f1-4240e57622cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"Type\": \"cards-realtime/proxy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateProfile","description":"

Allows the user to activate a previously created Processor Profile.

ProfileModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Only used for Create/Update/Get.
OrganizationId	Integer	The Organization ID of the Merchant Account.
Type	String	The ProfileType (see GetProfileTypes).

DataElementModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Name	Nullable String	The name of the element.
Value	Nullable String	The value of the element.
DataType	Nullable String	The data type of the element for validation purposes.

Return ResponseModel with Success as true or false.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","ActivateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"1679b002-c088-4904-9a8b-b6287c0c48ea","name":"ActivateProfile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": 8615,\r\n \"Type\": \"cards-realtime/proxy\",\r\n \"ThresholdType\": \"credit\",\r\n \"SaleMaxSingleDollarAmount\": 420,\r\n \"RefundMaxSingleDollarAmount\": 1337,\r\n \"SaleRollingDollarVolume\": 0,\r\n \"RefundRollingDollarVolume\": 69,\r\n \"NotificationEmail1\": \"email@email.com\",\r\n \"NotificationEmail2\": \"email2@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 17:15:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"f47aa8fb-ca00-4439-a7f1-4240e57622cc"},{"name":"DeactivateProfile","id":"d1a31152-c43c-4293-8c48-b169182fa7da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"Type\": \"cards-realtime/proxy\",\r\n \"ThresholdType\": \"credit\",\r\n \"SaleMaxSingleDollarAmount\": 420,\r\n \"RefundMaxSingleDollarAmount\": 1337,\r\n \"SaleRollingDollarVolume\": 0,\r\n \"RefundRollingDollarVolume\": 69,\r\n \"NotificationEmail1\": \"email@email.com\",\r\n \"NotificationEmail2\": \"email2@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateProfile","description":"

Allows the user to deactivate a previously created Processor Profile.

ProfileModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Only used for Create/Update/Get.
OrganizationId	Integer	The Organization ID of the Merchant Account.
Type	String	The ProfileType (see GetProfileTypes).

DataElementModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Name	Nullable String	The name of the element.
Value	Nullable String	The value of the element.
DataType	Nullable String	The data type of the element for validation purposes.

Return ResponseModel with Success as true or false.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","DeactivateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"82722ab5-c98b-497f-bab1-9777c8502d56","name":"DeactivateProfile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": 8615,\r\n \"Type\": \"cards-realtime/proxy\",\r\n \"ThresholdType\": \"credit\",\r\n \"SaleMaxSingleDollarAmount\": 420,\r\n \"RefundMaxSingleDollarAmount\": 1337,\r\n \"SaleRollingDollarVolume\": 0,\r\n \"RefundRollingDollarVolume\": 69,\r\n \"NotificationEmail1\": \"email@email.com\",\r\n \"NotificationEmail2\": \"email2@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 17:17:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"d1a31152-c43c-4293-8c48-b169182fa7da"},{"name":"GetProfile","id":"4846ce58-7461-4c2c-b830-685443494cce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"ProfileType\": \"cards-realtime/proxy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfile","description":"

Purpose: Allows the user to get a specific Processor Profile type for a specific Merchant Account organization.

ProfileFilterModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Used to authenticate the user requesting the Profile.
OrganizationId	Integer	The Organization ID of the Merchant Account that has the Profile in question.
ProfileType	String	The Profile Type being requested.

ReturnObject in ResponseModel: ProfileModel containing the data for the Profile requested.

ProfileModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Only used for Create/Update.
IsActive	Boolean	Indicates if the Processor Profile is active or not.
Type	String	The ProfileType (see GetProfileTypes).
DataElements	List	List of the data elements and their values for this Profile.

DataElementModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Name	String	The name of the element.
Value	String	The value of the element.
DataType	String	The data type of the element for validation purposes.

","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"cfe1db1b-794a-4de5-a85c-fc445505039c","name":"GetProfile","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": 8451,\r\n \"ProfileType\": \"cards-realtime/proxy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 15:51:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"IsActive\": true,\n \"Type\": \"cards-realtime/proxy\",\n \"DataElements\": [\n {\n \"Name\": \"IsConvenienceFeeEnabled\",\n \"Value\": \"True\",\n \"DataType\": \"Boolean\"\n },\n {\n \"Name\": \"IsTokenizationRequired\",\n \"Value\": \"False\",\n \"DataType\": \"Boolean\"\n },\n {\n \"Name\": \"AccountProcessingPolicy\",\n \"Value\": \"VMXDN--B\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"SaleMaxSingleDollarAmount\",\n \"Value\": null,\n \"DataType\": \"Int64\"\n },\n {\n \"Name\": \"RefundMaxSingleDollarAmount\",\n \"Value\": null,\n \"DataType\": \"Int64\"\n },\n {\n \"Name\": \"SaleRollingDollarVolume\",\n \"Value\": null,\n \"DataType\": \"Int64\"\n },\n {\n \"Name\": \"RefundRollingDollarVolume\",\n \"Value\": null,\n \"DataType\": \"Int64\"\n },\n {\n \"Name\": \"NotificationEmail1\",\n \"Value\": null,\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"NotificationEmail2\",\n \"Value\": null,\n \"DataType\": \"String\"\n }\n ],\n \"OrganizationId\": 12345,\n \"CreditPolicyClassifier\": \"CR\"\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ProfileModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"4846ce58-7461-4c2c-b830-685443494cce"},{"name":"GetProfiles","id":"c770b284-bd30-465c-95e0-9293649ff075","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfiles","description":"

Purpose: Returns all the Processor Profiles associated with a given Merchant Account Organization.

ReturnObject in ResponseModel: List<**ProfileModel**> containing all of the Profiles for the Merchant Account.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetProfiles"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"2727ec42-7401-49cd-83b4-93028d51ac7f","name":"GetProfiles","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetProfiles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Dec 2020 14:57:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"IsActive\": true,\n \"Type\": \"cards-realtime/proxy\",\n \"DataElements\": [\n {\n \"Name\": \"BusinessType\",\n \"Value\": \"1234\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"IsQuasiCash\",\n \"Value\": \"False\",\n \"DataType\": \"Boolean\"\n },\n {\n \"Name\": \"MerchantAddress\",\n \"Value\": \"\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"MerchantCity\",\n \"Value\": \"\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"MerchantCountryCode\",\n \"Value\": \"\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"MerchantName\",\n \"Value\": \"\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"MerchantPhoneNumber\",\n \"Value\": \"9111111\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"MerchantState\",\n \"Value\": \"NV\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"MerchantZip\",\n \"Value\": \"89012\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"StatementDescriptor\",\n \"Value\": \"\",\n \"DataType\": \"String\"\n },\n {\n \"Name\": \"Username\",\n \"Value\": \"4321\",\n \"DataType\": \"String\"\n }\n ],\n \"OrganizationId\": 12345,\n \"ThresholdType\": \"credit\",\n \"SaleMaxSingleDollarAmount\": 420,\n \"RefundMaxSingleDollarAmount\": 1337,\n \"SaleRollingDollarVolume\": null,\n \"RefundRollingDollarVolume\": 69,\n \"NotificationEmail1\": null,\n \"NotificationEmail2\": null\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ProfileModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"c770b284-bd30-465c-95e0-9293649ff075"}],"id":"d06f2ff7-f0b4-4962-abf7-7960fffe7b96","description":"

This chapter describes how to create and manage Processor Profiles used in a Merchant Account.

A Processor Profile is the merchant account information provided by the payment processor, which can include: merchant service providers (e.g. TSYS, Fiserv, Chase, etc...), ACH providers (e.g. PAYA, Jack Henry/Profit Stars, etc...), gift card providers (e.g. Valutec, Factor4, etc..).

The merchant account information is stored in a Profile. A Merchant Account can have more than one Processor Profile; however, only one Profile may be active for each ProfileType at a given time.

See Appendix A.3 for more information on specific processor parameter setup guidelines.

\n","_postman_id":"d06f2ff7-f0b4-4962-abf7-7960fffe7b96"},{"name":"Additional Configurations","item":[{"name":"GetServices","id":"bc651182-a9b2-4b15-8cbe-1509c785a066","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetServices","description":"

The GetServices request is used to retrieve the configuration Id value for each setting. Note that these values change between environments, so they must be obtained for both UAT and Production.

For example, when looking for the serviceConfigurationId for AVS/CVV settings, you must look for the CVO_Service and its corresponding Id:

            \"Id\": 2,\n            \"Name\": \"CVO_Service\",\n\n

You may then determine the serviceAppPropertyId for each individual setting:

                    \"Id\": 2,\n                    \"ServiceApplicationId\": 2,\n                    \"PropertyName\": \"NO_STREET_MATCH\",\n\n

For MyBridgePay Virtual Terminal settings, you must look for the MyBridgePay VT and its corresponding \"Id\":

            \"Id\": 3,\n            \"Name\": \"MyBridgePay VT\",\n\n

You may then determine the serviceAppPropertyId for each individual setting:

                    \"Id\": 14,\n                    \"ServiceApplicationId\": 3,\n                    \"PropertyName\": \"ENABLE_EMV\",\n\n

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetServices"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9f53279a-791c-4d58-9d8f-e46ed9c3a243","name":"GetServices","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateConfiguration"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcY2xhZ3VtZW5cRG9jdW1lbnRzXC5EZXZcQnJpZGdlcGF5LkJvYXJkaW5nLkFQSVxCcmlkZ2VwYXkuQm9hcmRpbmcuQVBJXGFwaVxCb2FyZGluZ1xDcmVhdGVDb25maWd1cmF0aW9u?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 21 Oct 2021 15:14:14 GMT"},{"key":"Content-Length","value":"10953"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Id\": 1,\n \"Name\": \"Batch Processing\",\n \"ShowInAppTab\": true,\n \"CreateDate\": \"2020-07-31T11:36:48.19\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 1,\n \"ServiceApplicationId\": 1,\n \"PropertyName\": \"PublicKeyFile\",\n \"DisplayName\": \"PGP Public Key File\",\n \"PropertyType\": \"string\",\n \"Validator\": \"PGPKeyValidator\",\n \"CreateDate\": \"2020-07-31T11:36:48.207\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2,\n \"Name\": \"CVO_Service\",\n \"ShowInAppTab\": false,\n \"CreateDate\": \"2020-07-31T11:37:30.96\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 2,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_STREET_MATCH\",\n \"DisplayName\": \"Street Address does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 3,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_ZIP_MATCH\",\n \"DisplayName\": \"ZIP Code does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 4,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_NAME_MATCH\",\n \"DisplayName\": \"Account Holder does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 5,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NOT_VERIFIED\",\n \"DisplayName\": \"Address not verified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 6,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"AVS_ERROR\",\n \"DisplayName\": \"AVS error (retry, system unavailable or time out)\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 7,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NOT_SUPPORTED\",\n \"DisplayName\": \"AVS not supported by issuer\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 8,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"UNRECOGNIZED_AVS\",\n \"DisplayName\": \"Unrecognized AVS response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 9,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NO_MATCH\",\n \"DisplayName\": \"CVV does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 10,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NOT_PROCESSED\",\n \"DisplayName\": \"CVV not processed\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 11,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NOT_PRESENT\",\n \"DisplayName\": \"CVV not provided\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 12,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"ISSUER_NOT_CERTIFIED\",\n \"DisplayName\": \"Issuer not certified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"UNRECOGNIZED_CVV\",\n \"DisplayName\": \"Unrecognized CVV response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.99\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 23,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_STREET_AND_ZIP_MATCH\",\n \"DisplayName\": \"Street Address and ZIP Code do not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2023-01-13T13:39:21.313\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 3,\n \"Name\": \"MyBridgePay VT\",\n \"ShowInAppTab\": false,\n \"CreateDate\": \"2020-07-31T11:38:09.367\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 14,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"ENABLE_EMV\",\n \"DisplayName\": \"Enable EMV\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.407\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 15,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"ENABLE_CARD_VERIFICATION\",\n \"DisplayName\": \"Enable Card Verification Transaction Type\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.42\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 16,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"CARD_VERIFICATION_CVV_REQUIRED\",\n \"DisplayName\": \"CVV\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.42\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 17,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"CARD_VERIFICATION_ADDRESS_REQUIRED\",\n \"DisplayName\": \"Billing Street Address\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.42\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 18,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"CARD_VERIFICATION_ZIP_REQUIRED\",\n \"DisplayName\": \"Billing Zip Code\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.437\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 19,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"INDUSTRY\",\n \"DisplayName\": \"Industry\",\n \"PropertyType\": \"string\",\n \"Validator\": \"IndustryTypeValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.437\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 24,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"ENABLE_DUPLICATE_OVERRIDE\",\n \"DisplayName\": \"Duplicate Override\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2023-03-21T13:14:21.21\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 4,\n \"Name\": \"RoleBehaviorSection\",\n \"ShowInAppTab\": false,\n \"CreateDate\": \"2020-12-23T15:52:45.813\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 20,\n \"ServiceApplicationId\": 4,\n \"PropertyName\": \"HideSystemRoles\",\n \"DisplayName\": \"Hide System Roles\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-12-23T15:53:10.863\",\n \"LastUpdated\": \"2020-12-23T15:54:30.477\",\n \"LastUpdatedBy\": \"ebeeton\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 21,\n \"ServiceApplicationId\": 4,\n \"PropertyName\": \"UseRoleGrading\",\n \"DisplayName\": \"Use Role Grading\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-12-23T15:53:10.863\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 5,\n \"Name\": \"NMI Emulator\",\n \"ShowInAppTab\": true,\n \"CreateDate\": \"2021-03-24T10:10:33.717\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 22,\n \"ServiceApplicationId\": 5,\n \"PropertyName\": \"INDUSTRY\",\n \"DisplayName\": \"Industry\",\n \"PropertyType\": \"string\",\n \"Validator\": \"IndustryTypeValidator\",\n \"CreateDate\": \"2021-03-24T10:10:47.373\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"bc651182-a9b2-4b15-8cbe-1509c785a066"},{"name":"GetConfiguration","id":"c8df599e-2455-4d66-998a-01ef6a87e73b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetConfiguration","description":"

GetConfiguration will return the details for an existing configuration. An Id will be returned for the overarching configuration along with individual Id for each specific configuration setting.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"779433e0-e1ab-407e-a720-afc2a156d727","name":"GetConfiguration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": \r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateConfiguration"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcY2xhZ3VtZW5cRG9jdW1lbnRzXC5EZXZcQnJpZGdlcGF5LkJvYXJkaW5nLkFQSVxCcmlkZ2VwYXkuQm9hcmRpbmcuQVBJXGFwaVxCb2FyZGluZ1xDcmVhdGVDb25maWd1cmF0aW9u?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 21 Oct 2021 15:14:14 GMT"},{"key":"Content-Length","value":"10953"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Id\": 7200,\n \"ServiceApplicationId\": 2,\n \"ServiceConsumerId\": 1588,\n \"IsActive\": false,\n \"CreateDate\": \"2023-11-03T15:16:43.267\",\n \"LastUpdated\": \"2024-06-26T15:56:58.913\",\n \"LastUpdatedBy\": \"username\",\n \"ServiceApplication\": {\n \"Id\": 2,\n \"Name\": \"CVO_Service\",\n \"ShowInAppTab\": false,\n \"CreateDate\": \"2020-07-31T11:37:30.96\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 2,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_STREET_MATCH\",\n \"DisplayName\": \"Street Address does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 3,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_ZIP_MATCH\",\n \"DisplayName\": \"ZIP Code does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 4,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_NAME_MATCH\",\n \"DisplayName\": \"Account Holder does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 5,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NOT_VERIFIED\",\n \"DisplayName\": \"Address not verified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 6,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"AVS_ERROR\",\n \"DisplayName\": \"AVS error (retry, system unavailable or time out)\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 7,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NOT_SUPPORTED\",\n \"DisplayName\": \"AVS not supported by issuer\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 8,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"UNRECOGNIZED_AVS\",\n \"DisplayName\": \"Unrecognized AVS response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 9,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NO_MATCH\",\n \"DisplayName\": \"CVV does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 10,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NOT_PROCESSED\",\n \"DisplayName\": \"CVV not processed\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 11,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NOT_PRESENT\",\n \"DisplayName\": \"CVV not provided\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 12,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"ISSUER_NOT_CERTIFIED\",\n \"DisplayName\": \"Issuer not certified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"UNRECOGNIZED_CVV\",\n \"DisplayName\": \"Unrecognized CVV response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.99\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 23,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_STREET_AND_ZIP_MATCH\",\n \"DisplayName\": \"Street Address and ZIP Code do not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2023-01-13T13:39:21.313\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConsumer\": {\n \"Id\": 1588,\n \"KeyId\": \"331103cfb7754b5e9700f5d29a5821d5\",\n \"OrganizationId\": 11861,\n \"CreateDate\": \"2022-01-11T09:45:55.527\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConfigValues\": [\n {\n \"Id\": 13406,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 2,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.267\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 2,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_STREET_MATCH\",\n \"DisplayName\": \"Street Address does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13407,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 3,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.267\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 3,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_ZIP_MATCH\",\n \"DisplayName\": \"ZIP Code does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13408,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 4,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 4,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_NAME_MATCH\",\n \"DisplayName\": \"Account Holder does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13409,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 5,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 5,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NOT_VERIFIED\",\n \"DisplayName\": \"Address not verified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13410,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 6,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 6,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"AVS_ERROR\",\n \"DisplayName\": \"AVS error (retry, system unavailable or time out)\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13411,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 7,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 7,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NOT_SUPPORTED\",\n \"DisplayName\": \"AVS not supported by issuer\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13412,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 8,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 8,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"UNRECOGNIZED_AVS\",\n \"DisplayName\": \"Unrecognized AVS response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13413,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 9,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 9,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NO_MATCH\",\n \"DisplayName\": \"CVV does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13414,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 10,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 10,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NOT_PROCESSED\",\n \"DisplayName\": \"CVV not processed\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13415,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 11,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 11,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"CVV_NOT_PRESENT\",\n \"DisplayName\": \"CVV not provided\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13416,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 12,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 12,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"ISSUER_NOT_CERTIFIED\",\n \"DisplayName\": \"Issuer not certified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13417,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 13,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 13,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"UNRECOGNIZED_CVV\",\n \"DisplayName\": \"Unrecognized CVV response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.99\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13418,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 23,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 23,\n \"ServiceApplicationId\": 2,\n \"PropertyName\": \"NO_STREET_AND_ZIP_MATCH\",\n \"DisplayName\": \"Street Address and ZIP Code do not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2023-01-13T13:39:21.313\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ServiceConfiguration\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"c8df599e-2455-4d66-998a-01ef6a87e73b"},{"name":"CreateConfiguration","id":"c0dba4d2-a111-489d-a8a6-53595ee283d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ServiceConfiguration\": {\r\n \"ServiceApplicationId\": ,\r\n \"IsActive\": true,\r\n \"ServiceConsumer\": {\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n },\r\n \"ServiceConfigValues\": [\r\n {\r\n \"ServiceAppPropertyId\": 2,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 3,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 4,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 5,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 6,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 7,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 8,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 9,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 10,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 11,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 12,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 13,\r\n \"Value\": \"false\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateConfiguration","description":"

Use CreateConfiguration to generate a new configuration. The ServiceApplicationID of the service you intend to create must be provided along with configurations for each setting.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"f44742c6-956d-4973-8abd-5bb68ae8abb5","name":"CreateConfiguration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ServiceConfiguration\": {\r\n \"ServiceApplicationId\": {{serviceApplicationId}},\r\n \"IsActive\": true,\r\n \"ServiceConsumer\": {\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n },\r\n \"ServiceConfigValues\": [\r\n {\r\n \"ServiceAppPropertyId\": 2,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 3,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 4,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 5,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 6,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 7,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 8,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 9,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 10,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 11,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 12,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"ServiceAppPropertyId\": 13,\r\n \"Value\": \"false\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateConfiguration"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcY2xhZ3VtZW5cRG9jdW1lbnRzXC5EZXZcQnJpZGdlcGF5LkJvYXJkaW5nLkFQSVxCcmlkZ2VwYXkuQm9hcmRpbmcuQVBJXGFwaVxCb2FyZGluZ1xDcmVhdGVDb25maWd1cmF0aW9u?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 21 Oct 2021 15:14:14 GMT"},{"key":"Content-Length","value":"10953"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Id\": 1234,\n \"ServiceApplicationId\": ,\n \"ServiceConsumerId\": 1234,\n \"IsActive\": true,\n \"CreateDate\": \"2021-10-21T08:14:12.9228792-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceApplication\": {\n \"Id\": 4,\n \"Name\": \"CVO_Service\",\n \"ShowInAppTab\": false,\n \"CreateDate\": \"2020-07-17T13:33:33.17\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 2,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_STREET_MATCH\",\n \"DisplayName\": \"Street Address does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 3,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_ZIP_MATCH\",\n \"DisplayName\": \"ZIP Code does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 4,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_NAME_MATCH\",\n \"DisplayName\": \"Account Holder does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 5,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_VERIFIED\",\n \"DisplayName\": \"Address not verified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 6,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"AVS_ERROR\",\n \"DisplayName\": \"AVS error (retry, system unavailable or time out)\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 7,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_SUPPORTED\",\n \"DisplayName\": \"AVS not supported by issuer\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 8,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_AVS\",\n \"DisplayName\": \"Unrecognized AVS response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 9,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NO_MATCH\",\n \"DisplayName\": \"CVV does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 10,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PROCESSED\",\n \"DisplayName\": \"CVV not processed\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 11,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PRESENT\",\n \"DisplayName\": \"CVV not provided\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 12,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"ISSUER_NOT_CERTIFIED\",\n \"DisplayName\": \"Issuer not certified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_CVV\",\n \"DisplayName\": \"Unrecognized CVV response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConsumer\": {\n \"Id\": 2104,\n \"KeyId\": \"12345384d2f24e35948d6ba0302cfdc4\",\n \"OrganizationId\": 12345,\n \"CreateDate\": \"2021-02-12T16:29:04.427\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConfigValues\": [\n {\n \"Id\": 2803,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 2,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.923875-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 5,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_STREET_MATCH\",\n \"DisplayName\": \"Street Address does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2804,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 3,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9249037-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 6,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_ZIP_MATCH\",\n \"DisplayName\": \"ZIP Code does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2805,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 4,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.926868-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 7,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_NAME_MATCH\",\n \"DisplayName\": \"Account Holder does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2806,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 5,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.926868-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 8,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_VERIFIED\",\n \"DisplayName\": \"Address not verified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2807,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 6,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9278652-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 9,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"AVS_ERROR\",\n \"DisplayName\": \"AVS error (retry, system unavailable or time out)\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2808,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 7,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9288623-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 10,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_SUPPORTED\",\n \"DisplayName\": \"AVS not supported by issuer\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2809,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 8,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9308586-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 11,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_AVS\",\n \"DisplayName\": \"Unrecognized AVS response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2810,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 9,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9318567-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 12,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NO_MATCH\",\n \"DisplayName\": \"CVV does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2811,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 10,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9328525-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 13,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PROCESSED\",\n \"DisplayName\": \"CVV not processed\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2812,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 11,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9338495-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 14,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PRESENT\",\n \"DisplayName\": \"CVV not provided\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2813,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 12,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9348468-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 15,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"ISSUER_NOT_CERTIFIED\",\n \"DisplayName\": \"Issuer not certified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2814,\n \"ServiceConfigurationId\": 2180,\n \"ServiceAppPropertyId\": 13,\n \"Value\": \"false\",\n \"CreateDate\": \"2021-10-21T08:14:12.9358442-07:00\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 16,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_CVV\",\n \"DisplayName\": \"Unrecognized CVV response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-17T13:33:33.2\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ObjectState\": 1,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ServiceConfiguration\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"c0dba4d2-a111-489d-a8a6-53595ee283d1"},{"name":"UpdateConfiguration","id":"0c647df6-066b-4cec-8b3c-e2d426642977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ServiceConfiguration\": {\r\n \"Id\": ,\r\n \"ServiceApplicationId\": ,\r\n \"IsActive\": true,\r\n \"ServiceConsumer\": {\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n },\r\n \"ServiceConfigValues\": [\r\n {\r\n \"Id\": 13406,\r\n \"ServiceAppPropertyId\": 2,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"Id\": 18722,\r\n \"ServiceConfigurationId\": 10235,\r\n \"ServiceAppPropertyId\": 24,\r\n \"Value\": \"true\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateConfiguration","description":"

Use UpdateConfiguration to update an existing configuration. An Id for the ServiceConfiguration must be provided along with the individual Ids for each configuration setting.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","UpdateConfiguration"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"f8880f9a-a9da-4ac4-b2c6-77f77d1e8ec6","name":"UpdateConfiguration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ServiceConfiguration\": {\r\n \"Id\": ,\r\n \"ServiceApplicationId\": ,\r\n \"IsActive\": true,\r\n \"ServiceConsumer\": {\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n },\r\n \"ServiceConfigValues\": [\r\n {\r\n \"Id\": 13406,\r\n \"ServiceAppPropertyId\": 2,\r\n \"Value\": \"false\"\r\n },\r\n {\r\n \"Id\": 18722,\r\n \"ServiceConfigurationId\": 10235,\r\n \"ServiceAppPropertyId\": 24,\r\n \"Value\": \"true\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateConfiguration"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcY2xhZ3VtZW5cRG9jdW1lbnRzXC5EZXZcQnJpZGdlcGF5LkJvYXJkaW5nLkFQSVxCcmlkZ2VwYXkuQm9hcmRpbmcuQVBJXGFwaVxCb2FyZGluZ1xDcmVhdGVDb25maWd1cmF0aW9u?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 21 Oct 2021 15:14:14 GMT"},{"key":"Content-Length","value":"10953"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Id\": 7200,\n \"ServiceApplicationId\": ,\n \"ServiceConsumerId\": 1588,\n \"IsActive\": true,\n \"CreateDate\": \"2023-11-03T15:16:43.267\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceApplication\": {\n \"Id\": 2,\n \"Name\": \"CVO_Service\",\n \"ShowInAppTab\": false,\n \"CreateDate\": \"2020-07-31T11:37:30.96\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 2,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_STREET_MATCH\",\n \"DisplayName\": \"Street Address does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 3,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_ZIP_MATCH\",\n \"DisplayName\": \"ZIP Code does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 4,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_NAME_MATCH\",\n \"DisplayName\": \"Account Holder does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 5,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_VERIFIED\",\n \"DisplayName\": \"Address not verified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 6,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"AVS_ERROR\",\n \"DisplayName\": \"AVS error (retry, system unavailable or time out)\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 7,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_SUPPORTED\",\n \"DisplayName\": \"AVS not supported by issuer\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 8,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_AVS\",\n \"DisplayName\": \"Unrecognized AVS response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 9,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NO_MATCH\",\n \"DisplayName\": \"CVV does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 10,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PROCESSED\",\n \"DisplayName\": \"CVV not processed\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 11,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PRESENT\",\n \"DisplayName\": \"CVV not provided\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 12,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"ISSUER_NOT_CERTIFIED\",\n \"DisplayName\": \"Issuer not certified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_CVV\",\n \"DisplayName\": \"Unrecognized CVV response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.99\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConsumer\": {\n \"Id\": 1588,\n \"KeyId\": \"331103cfb7754b5e9700f5d29a5821d5\",\n \"OrganizationId\": 11861,\n \"CreateDate\": \"2022-01-11T09:45:55.527\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConfigValues\": [\n {\n \"Id\": 13406,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 2,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.267\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 2,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_STREET_MATCH\",\n \"DisplayName\": \"Street Address does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13407,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 3,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.267\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 3,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_ZIP_MATCH\",\n \"DisplayName\": \"ZIP Code does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13408,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 4,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 4,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NO_NAME_MATCH\",\n \"DisplayName\": \"Account Holder does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13409,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 5,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 5,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_VERIFIED\",\n \"DisplayName\": \"Address not verified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13410,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 6,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 6,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"AVS_ERROR\",\n \"DisplayName\": \"AVS error (retry, system unavailable or time out)\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13411,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 7,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 7,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"NOT_SUPPORTED\",\n \"DisplayName\": \"AVS not supported by issuer\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13412,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 8,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 8,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_AVS\",\n \"DisplayName\": \"Unrecognized AVS response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13413,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 9,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.28\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 9,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NO_MATCH\",\n \"DisplayName\": \"CVV does not match\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13414,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 10,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 10,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PROCESSED\",\n \"DisplayName\": \"CVV not processed\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13415,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 11,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 11,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"CVV_NOT_PRESENT\",\n \"DisplayName\": \"CVV not provided\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13416,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 12,\n \"Value\": \"false\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 12,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"ISSUER_NOT_CERTIFIED\",\n \"DisplayName\": \"Issuer not certified\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.973\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 13417,\n \"ServiceConfigurationId\": 7200,\n \"ServiceAppPropertyId\": 13,\n \"Value\": \"true\",\n \"CreateDate\": \"2023-11-03T15:16:43.297\",\n \"LastUpdated\": \"2024-07-05T16:24:15.6592734-04:00\",\n \"LastUpdatedBy\": \"noahreseller\",\n \"ServiceAppProperty\": {\n \"Id\": 13,\n \"ServiceApplicationId\": ,\n \"PropertyName\": \"UNRECOGNIZED_CVV\",\n \"DisplayName\": \"Unrecognized CVV response\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-07-31T11:37:41.99\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 2,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ObjectState\": 2,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ServiceConfiguration\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"},{"id":"86a629bb-8a94-4679-b467-8ee7a0a0bf69","name":"UpdateConfiguration (Virtual Terminal)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"ServiceConfiguration\": {\r\n \"Id\": ,\r\n \"ServiceApplicationId\": ,\r\n \"IsActive\": true,\r\n \"ServiceConsumer\": {\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n },\r\n \"ServiceConfigValues\" : [\r\n {\r\n \"Id\": 18716,\r\n \"ServiceConfigurationId\": 10235,\r\n \"ServiceAppPropertyId\": 14,\r\n \"Value\": \"true\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateConfiguration"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcY2xhZ3VtZW5cRG9jdW1lbnRzXC5EZXZcQnJpZGdlcGF5LkJvYXJkaW5nLkFQSVxCcmlkZ2VwYXkuQm9hcmRpbmcuQVBJXGFwaVxCb2FyZGluZ1xDcmVhdGVDb25maWd1cmF0aW9u?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 21 Oct 2021 15:14:14 GMT"},{"key":"Content-Length","value":"10953"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Id\": 10235,\n \"ServiceApplicationId\": 3,\n \"ServiceConsumerId\": 9559,\n \"IsActive\": true,\n \"CreateDate\": \"2026-03-23T17:07:13.443\",\n \"LastUpdated\": \"2026-03-24T16:54:50.9855973-04:00\",\n \"LastUpdatedBy\": \"noahreseller\",\n \"ServiceApplication\": {\n \"Id\": 3,\n \"Name\": \"MyBridgePay VT\",\n \"ShowInAppTab\": false,\n \"CreateDate\": \"2020-07-31T11:38:09.367\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperties\": [\n {\n \"Id\": 14,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"ENABLE_EMV\",\n \"DisplayName\": \"Enable EMV\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.407\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConsumer\": {\n \"Id\": 9559,\n \"KeyId\": \"077153740b7d4fc681968d170801a190\",\n \"OrganizationId\": 12345,\n \"CreateDate\": \"2026-03-23T17:07:13.16\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceConfigurations\": [],\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ServiceConfigValues\": [\n {\n \"Id\": 18716,\n \"ServiceConfigurationId\": 10235,\n \"ServiceAppPropertyId\": 14,\n \"Value\": \"true\",\n \"CreateDate\": \"2026-03-23T17:07:13.457\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ServiceAppProperty\": {\n \"Id\": 14,\n \"ServiceApplicationId\": 3,\n \"PropertyName\": \"ENABLE_EMV\",\n \"DisplayName\": \"Enable EMV\",\n \"PropertyType\": \"bool\",\n \"Validator\": \"BooleanValidator\",\n \"CreateDate\": \"2020-08-17T12:03:05.407\",\n \"LastUpdated\": null,\n \"LastUpdatedBy\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"ObjectState\": 2,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ServiceConfiguration\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"0c647df6-066b-4cec-8b3c-e2d426642977"}],"id":"c3cc80ef-8d9d-4ae9-9e3d-760de7d55a32","description":"

The Boarding API also allows for configuring AVS/CVV settings as well as Virtual Terminal settings. The following section details how to use the CreateConfiguration and UpdateConfiguration functions.

Nested objects are used to interact with these settings. The following tables describe how these are structured:

ServiceConfiguration Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Description
R	ServiceApplicationId	integer	The id for the application you intend to update. Valid values are: 4 and 7 4 = AVS/CVV Settings 5 = Virtual Terminal Settings
R	ServiceConsumer	object	An object containing the OrganizationId of the account on which the Configuration is created or updated.
R	ServiceConfigValues	object	An object containing pairs of ServiceAppPropertyId's and

ServiceConsumer Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Description
R	OrganizationId	integer	The OrganizationId of the account on which the Configuration is created or updated.

ServiceConfigValues Object

Each key pair in the JSON object will contain the two following data elements:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Description
R	ServiceAppPropertyId	integer	The Id of the setting to be modified. See the ServiceAppPropertyId table below.
R	Value	boolean	Indicates whether the ServiceAppPropertyId is enabled (true) or disabled (false).
C	Id	integer	The Id of a previously created configuration. Only to be used on Updates.

ServiceAppPropertyId Values

The ServiceAppPropertyId identifies settings available for configuration. The specific ServiceAppPropertyIds change depending on the environment, so a GetServices request is used to retrieve the values for each environment you intend to use:

ServiceAppPropertyId	Property Name	Data Type	Description
See GetServices section	No Street Match	boolean	When true, declines the transaction if the provided street address does not match with the card data.
See GetServices section	No ZIP Match	boolean	When true, declines the transaction if the provided street address does not match with the card data.
See GetServices section	No Name Match	boolean	When true, declines the transaction if the provided street address does not match with the card data.
See GetServices section	Not Verified	boolean	When true, declines the transaction if the processor returns a message indicating the provided information could not be verified.
See GetServices section	AVS Error	boolean	When true, declines the transaction if the processor returns a message indicating the AVS failed.
See GetServices section	Not Supported	boolean	When true, declines the transaction if the processor returns a message indicating AVS is not supported.
See GetServices section	Unrecognized AVS	boolean	When true, declines the transaction if the processor returns a message indicating the AVS was unrecognized.
See GetServices section	CVV No Match	boolean	When true, declines the transaction if the provided CVV does not match.
See GetServices section	CVV Not Processed	boolean	When true, declines the transaction if the provided CVV was not evaluated by the processor.
See GetServices section	CVV Not Present	boolean	When true, declines the transaction if the CVV was not provided.
See GetServices section	Issuer Not Certified	boolean	When true, declines the transaction if the issuer of the provided card is not certified for CVV evaluation.
See GetServices section	Unrecognized CVV	boolean	When true, declines the transaction if the provided CVV is not recognized.
See GetServices section	Enable EMV	boolean	When true, allows EMV transactions to be processed via the Virtual Terminal.
See GetServices section	Enable Card Verification	boolean	When true, enables the card verification transaction type.
See GetServices section	Card Verification CVV Required	boolean	When true, requires CVV on transactions.
See GetServices section	Card Verification Address Required	boolean	When true, requires billing street address on transactions.
See GetServices section	Card Verification ZIP Required	boolean	When true, requires billing ZIP on transactions.

","_postman_id":"c3cc80ef-8d9d-4ae9-9e3d-760de7d55a32"}],"id":"0d5e1535-8530-4ffd-9775-cdfccb5cac92","description":"

The Merchant Account Organization has additional objects beneath it to control things like the processor configuration, settlement, duplicate checking, etc. These objects are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object	Description
ApplicationConfig	A Merchant Account can have multiple Applications. These represent the various features the Merchant Account has available. For instance, SOAP allows for transaction processing via Bridgecomm API. Information about the various applications is in the GetApplications section.
GatewayConfiguration	A Merchant Account can only have one GatewayConfiguration. This object contains things like duplicate checking, settlement time, and emails for batch notifications.
Profile	A merchant can have multiple Profiles.

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a5bb8b62-c29c-4042-92cb-24adb08e3ce0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ab63f99c-38c1-4605-8ecb-ac2fd8b976b3"}}],"_postman_id":"0d5e1535-8530-4ffd-9775-cdfccb5cac92"},{"name":"User Management","item":[{"name":"GetUserTypes","id":"6b2374f6-701d-4dcf-aeaa-4889b1276353","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUserTypes","description":"

Every user created must have an associated UserType to define the type of user associated at each hierarchy level. These are system level user types and are automatically assigned by default when a user is created at any organization/account level.

Using this method will return the list of Ids as described below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	User Type
2	Reseller
3	Sales Agent
4	Merchant Group
5	Merchant Account

","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetUserTypes"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"c975a204-1309-4f1e-828a-ef73e4e01728","name":"GetUserTypes Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUserTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 20:57:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n \"Admin = 0 \",\n \"Reseller = 2\",\n \"Sales Agent = 3\",\n \"Merchant Group = 4\",\n \"Merchant Account = 5\"\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List string\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"6b2374f6-701d-4dcf-aeaa-4889b1276353"},{"name":"GetRoles","id":"ecefa46a-853f-49f2-8f36-fddc31d5e630","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetRoles","description":"

Every user created must have an associated RoleId to define the what the user is allowed to do. Roles can vary depending on the environment. Use the appropriate ID for the user you will create.

Using this method will return the list of Role Ids as described below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	RoleId
2	Reseller
4115	Sales Agent
4117	Merchant Group
4116	Merchant Account

","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetRoles"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"e22ade90-3ffa-4402-b2ac-e64d3a69c4fa","name":"GetRoles","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetRoles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 21:02:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n \"Admin=1\",\n \"Reseller=2\",\n \"Reporting=9\",\n \"Super User=12\",\n \"Supersede=17\",\n \"ReadOnly Merchant=20\",\n \"QA Test=23\",\n \"MerchantAdmin=25\",\n \"NoCreditMerchant=26\",\n \"New Testrole QA=33\",\n \"test new Role QA1=34\",\n \"new merchant QA=35\",\n \"Test Merchant 16Jun2015=37\",\n \"Asp Test Role=39\",\n \"Admins=41\",\n \"Full Rights=46\",\n \"Batch Management=51\",\n \"VT Only=52\",\n \"VT - Credit Card/Check 21=60\",\n \"MerchantProdRole=61\",\n \"Lodging Merchant=62\",\n \"testrole0616=65\",\n \"NewResellerRole=68\",\n \"test040617=81\",\n \"JennaMerchRole=82\",\n \"qa100317=84\",\n \"addnewrole=91\",\n \"qa022018=2093\",\n \"qa020218nosf=2094\",\n \"TEGClerk=2095\",\n \"ResellerAdmin=2099\",\n \"MerchantAdminLtd=4108\",\n \"qa022119=4113\",\n \"Sale/refund/ACH/recurring=4114\",\n \"Sales Agent=4115\",\n \"Merchant Account=4116\",\n \"Merchant Group=4117\",\n \"MAwithBoarding=4129\",\n \"Reseller (Restricted)=4131\",\n \"Sales Agent (Restricted)=4132\",\n \"Reseller Roler120919=4138\",\n \"LegacyMerchantRole=4157\",\n \"Reseller Reporting Only=4166\",\n \"Merchant-VT=4167\",\n \"Reseller-VT=4168\",\n \"NP Reseller=4177\",\n \"Branding Role=4189\",\n \"AdminMG0505=4202\",\n \"Test Only=4203\",\n \"ResllerBranding=4212\"\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List string\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"ecefa46a-853f-49f2-8f36-fddc31d5e630"},{"name":"CreateUser","id":"5a6134bd-0d1a-401b-9485-aad30e81f07c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theNewUserName\",\r\n \"FirstName\": \"MerchantAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"APasswordForUser\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 5,\r\n \"RoleId\": 4116,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser","description":"

Purpose: Allows the user to create new users.

UserModel

Property Name	Required	Type	Min	Max	Notes
Credentials	Yes	Credentials			Only used for Create/Update/Get.
UserName	Yes	String	2	50	The user's username.
FirstName	Yes	String	2	40	The user's first name.
LastName	Yes	String	2	40	The user's last name.
Password	Yes	String	8	20	The user's Password (not returned on GetUser). Must adhere to the following guidelines: 1 Uppercase Character 1 Lowercase Character 1 Number 1 Non-Alphanumeric Character Minimum of 6 Characters
UserType	Yes	Integer	1	2	See GetUserTypes.
RoleId	Yes	Integer	1	10	The unique ID of the user's role (see GetRoles).
OrganizationId	Yes	Integer	1	10	The default Organization ID for the user.
EmailAddress	Yes	String	2	200	The e-mail address associated with the user.
EmailAddressType	Yes	String	4	4	Identifier for the email address type (e.g. Home, Work).
AddressLine1	No	String	2	100	The address on the user's record.
AddressLine2	No	Nullable String	0	100
AddressLine3	No	Nullable String	0	100
City	No	String	2	25	The city on the user's address record.
State	No	String	2	2	The state on the user's address record.
ZipCode	No	String	5	10	The zip code on the user's address record.
County	No	String	2	25	The county on the user's address record.
AddressType	No	String	4	4	String identifier for the address type (e.g. Home, Work).
Phone	No	String	2	15	The phone number associated with the user.
PhoneType	No	Integer	4	4	String identifier for the phone number type (i.e. Home, Work).
LockedOut	Response Only	Boolean	4	5	Indicates if the user is locked out.
CreatedDate	Response Only	Nullable DateTime	19	23	The date the user was created.
LastPasswordFailureDate	Response Only	Nullable DateTime	19	23	The last time the user entered the password incorrectly.
PasswordChangedDate	Response Only	Nullable DateTime	19	23	The last time the user's password was changed.
UserId	Use on Update	Integer	1	10	The unique identifier for the user only used for subsequent changes for user.

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"88ae5189-0abf-41f5-bc17-b208c8875ff3","name":"Creating a Merchant Group User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserName\",\r\n \"FirstName\": \"MerchantGroup\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 4,\r\n \"RoleId\": 4117,\r\n \"OrganizationId\": ExampleMerchantGroupId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 21:18:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ID of User\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"},{"id":"950ee816-e2c3-4a1f-bd60-c2d612e6f513","name":"Create a Merchant Account User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserName\",\r\n \"FirstName\": \"MerchantAccount\",\r\n \"LastName\": \"User\",\r\n \"Password\": \"Desired User Password\",\r\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\r\n \"EmailAddressType\": \"Work\",\r\n \"UserType\": 5,\r\n \"RoleId\": 4116,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 21:24:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ID of User\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"5a6134bd-0d1a-401b-9485-aad30e81f07c"},{"name":"UpdateUser","id":"d0f4ef91-9207-493e-a726-c2818eff2c1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"MiddleName\": \"RES\",\r\n \"UserId\": ID of User,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateUser","description":"

Purpose: Allows the user to update users. A password cannot be updated with UpdateUser. Use the ChangePassword call instead.

UserModel

Property Name	Required	Type	Min	Max	Notes
Credentials	Yes	Credentials			Only used for Create/Update/Get.
UserId	Yes	Integer	1	10	The unique identifier for the user, only used for subsequent changes for user.
OrganizationId	Yes	Integer	1	10	The default Organization ID for the user.
Password	N/A	Null			The user's Password is not returned on Update and cannot be updated via this call.
UserName	No	String	2	50	The user's username.
FirsName	No	String	2	40	The user's first name.
LastName	No	String	2	40	The user's last name.
AddressLine1	No	String	2	100	The address on the user's record.
AddressLine2	No	Nullable String	0	100
AddressLine3	No	Nullable String	0	100
City	No	String	2	25	The city on the user's address record.
State	No	String	2	2	The state on the user's address record.
PostalCode	No	String	5	10	The zip code on the user's address record.
County	No	String	2	25	The county on the user's address record.
HomePhone	No	String	2	15	The home phone number associated with the user.
PersonalPhone	no	String	2	15	The personal phone number associated with the user.
WorkPhone	no	String	2	15	The work phone number associated with the user.

Return ResponseModel with Success as true or false.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","UpdateUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"29de234f-5974-4257-b830-524790464e78","name":"UpdateUser","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"MiddleName\": \"RES\",\r\n \"UserId\": ID of User,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/UpdateUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 18:22:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"d0f4ef91-9207-493e-a726-c2818eff2c1a"},{"name":"GetUsers","event":[{"listen":"test","script":{"id":"c3e67b6b-ebe3-4ddf-9daa-3d440d812d4b","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c11d5baf-4ba1-4758-9ebb-eb9a4c52270e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUsers","description":"

Purpose: Allows the user to get a list of user records by a user filter.

UserFilterModel

Property Name	Required	Type	Min	Max	Notes
Credentials	Yes	Credentials			Used to authenticate the user requesting the user information.
UserId	No	Integer	1	10	The unique identifier for the user.
OrganizationId	No	Integer	1	10	The default Organization ID for the user.
ParentId	No	Integer	1	10	The parent Organization ID for the Organization ID.
UserName	No	String	2	50	The user's username.
FirsName	No	String	2	40	The user's first name.
LastName	No	String	2	40	The user's last name.
Email	No	String	2	200	The e-mail address associated with the user.
City	No	String	2	25	The city on the user's address record.
State	No	String	2	2	The state on the user's address record.
ZipCode	No	String	5	10	The zip code on the user's address record.
PageSize	No	Integer	1	4	Maximum number of Users to return. Default if not provided is 25.
Page	No	Integer	1	4	Page Number to return, zero based page number, e.g. if 300 total objects were returned based on filter, using a PageSize Default of 25, Pages would be 0 through 11.

ReturnObject in ResponseModel: List<**UserModel**> containing all the users that matched the criteria.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetUsers"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"1a93f7b4-cab8-4c0c-a5ba-9fb571010b91","name":"Get User with specific last name","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n \"LastName\": \"Last Name to Search\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUsers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 19:49:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"theUserName\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"Last Name to Search\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 4,\n \"CreatedDate\": \"2020-10-02T20:51:53.267\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-10-27T19:35:23.373\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4117,\n \"OrganizationId\": ExampleMerchantAccountId\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List UserModel\",\n \"PageSize\": 25,\n \"Page\": 0,\n \"Total\": 1\n}"},{"id":"079952dd-a7b9-496c-815e-4cbdb01fd419","name":"Get List of Users for a specific Merchant Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"PageSize\": 100,\r\n \"Page\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUsers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Aug 2020 14:22:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"theUserName\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-08-03T21:24:38.593\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-08-03T21:24:38.593\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"theUserName\",\n \"FirstName\": null,\n \"MiddleName\": null,\n \"LastName\": null,\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-10-09T17:14:24.457\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-10-09T17:14:24.457\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": null,\n \"EmailAddressType\": null,\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 0,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"youKnow\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:41:59.023\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-12-16T14:41:59.023\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"more\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:42:51.007\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-12-16T14:42:51.007\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"still\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:43:11.773\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-12-16T14:43:11.773\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"the\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:44:23.867\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-12-16T14:44:23.867\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"user\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:45:01.693\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-12-16T14:45:01.693\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"name\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:45:16.977\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-12-16T14:45:16.977\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"in\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:45:55.367\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-12-16T14:45:55.367\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"thisExample\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": \"xxxxxx\",\n \"LockedOut\": false,\n \"UserType\": 5,\n \"CreatedDate\": \"2020-12-16T14:46:43.117\",\n \"LastPasswordFailureDate\": \"2020-12-16T14:48:34.9\",\n \"PasswordChangedDate\": \"2020-12-16T14:46:43.117\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4116,\n \"OrganizationId\": ExampleMerchantAccountId\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List UserModel\",\n \"PageSize\": 100,\n \"Page\": 0,\n \"Total\": 10\n}\n"}],"_postman_id":"c11d5baf-4ba1-4758-9ebb-eb9a4c52270e"},{"name":"GetUser","id":"6ad8a329-b742-42a7-bea3-04c681009ae0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserId\": ID of User\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUser","description":"

Purpose: Allows the user to get a user record by a user filter.

UserFilterModel

ReturnObject in ResponseModel: List<**UserModel**> containing all the users that matched the criteria.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"3aab49fc-8600-4f08-ba3e-67a67846bfe8","name":"Get User Info on Merchant Group User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserId\": ID of User\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 19:42:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"The User Name\",\n \"FirstName\": \"MerchantAccount\",\n \"MiddleName\": null,\n \"LastName\": \"User\",\n \"Password\": null,\n \"LockedOut\": false,\n \"UserType\": 4,\n \"CreatedDate\": \"2020-10-02T20:51:53.267\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-10-27T19:35:23.373\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 4117,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"UserModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"},{"id":"836436bf-85ed-4d7c-a6a3-757106ca438d","name":"Get Info on current UserName","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Aug 2020 21:08:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"UserId\": ID of User,\n \"UserName\": \"The User Name\",\n \"FirstName\": \"Reseller\",\n \"MiddleName\": null,\n \"LastName\": \"Users\",\n \"Password\": null,\n \"LockedOut\": false,\n \"UserType\": 2,\n \"CreatedDate\": \"2020-08-03T21:00:39.047\",\n \"LastPasswordFailureDate\": null,\n \"PasswordChangedDate\": \"2020-08-03T21:00:39.047\",\n \"AddressLine1\": null,\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": null,\n \"County\": null,\n \"State\": null,\n \"ZipCode\": null,\n \"CountryId\": null,\n \"AddressType\": null,\n \"EmailAddress\": \"boarding.example@Bridgepaynetwork.com\",\n \"EmailAddressType\": \"Work\",\n \"Phone\": null,\n \"PhoneType\": null,\n \"RoleId\": 2,\n \"OrganizationId\": ExampleMerchantAccountId\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"UserModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"6ad8a329-b742-42a7-bea3-04c681009ae0"},{"name":"ChangePassword","id":"91cf4343-f64c-469a-aa5f-5432c4c17a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserName\",\r\n \"NewPassword\": \"theNewPassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ChangePassword","description":"

Purpose: Allows the user to change another user's password.

UserModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Type	Min	Max	Notes
Credentials	Yes	Credentials	N/A	N/A	Only used for Create/Update/Get.
UserName	Yes	String	2	50	The username of the user whose password is being changed.
NewPassword	Yes	String	8	20	The user's new Password (not returned on Get). Must adhere to the following guidelines: 1 Uppercase Character 1 Lowercase Character 1 Number 1 Non-Alphanumeric Character Minimum of 6 Characters

Return ResponseModel with Success as true or false. If successful, the ID of the User will also be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","ChangePassword"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"e60ac91d-3204-4c06-8f4a-dd232a5b1d14","name":"ChangePassword","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserName\": \"theUserToChange\",\r\n \"NewPassword\": \"theNewPassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ChangePassword"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 27 Oct 2020 19:35:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"AnId\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"91cf4343-f64c-469a-aa5f-5432c4c17a88"},{"name":"ActivateUser","id":"306bdcb2-e2e6-4fc2-9472-eaa078099294","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ID of User\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateUser","description":"

Allows the user to activate a User that was Deactivated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials
Id	Integer	The ID of the user.

","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","ActivateUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"a56b2ceb-4dd1-41e8-b3f6-dc2ec1d33d6e","name":"Activate a deactivated merchant account user","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ID of User\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/ActivateUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Aug 2020 15:08:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ID of User\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"306bdcb2-e2e6-4fc2-9472-eaa078099294"},{"name":"DeactivateUser","id":"de14f79b-c476-4523-b49d-4fcdf2167141","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ID of User\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateUser","description":"

Allows the user to deactivate a User.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","DeactivateUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"af783f06-1c3f-4c7f-9fef-5e0c7c98579f","name":"Deactivate a merchant account user","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": ID of User\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/DeactivateUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Aug 2020 15:09:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"527500\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"de14f79b-c476-4523-b49d-4fcdf2167141"}],"id":"f1b5ecb6-00cc-4eb8-b484-c3f7145692a1","description":"

This chapter describes how to create and manage users for an organization/account. Applicable organization/account user options are: Reseller, Sales Agent, Merchant Group, and Merchant Account users.

\n","_postman_id":"f1b5ecb6-00cc-4eb8-b484-c3f7145692a1"},{"name":"User Organization Access","item":[{"name":"GrantOrganizationalAccess","id":"eb914fe0-0777-4fdc-8909-4429fe8830b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserId\": ID of User,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GrantOrganizationalAccess","description":"

Allows the user to grant organization access for a User.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GrantOrganizationalAccess"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"14ebc020-1719-4c50-acf1-25ff2f82a786","name":"Grant Access to Organization for a User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserId\": ID of User,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GrantOrganizationalAccess"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Oct 2020 12:45:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"eb914fe0-0777-4fdc-8909-4429fe8830b8"},{"name":"RevokeOrganizationalAccess","id":"89b7c5ec-88c5-41c9-8120-de9101a23a23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserId\": ID of User,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/RevokeOrganizationalAccess","description":"

Allows the user to revoke organization access for a User.

The OrganizationId may be for an individual merchant account or a merchant group.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","RevokeOrganizationalAccess"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"fd3cb9d3-c652-4675-a442-0bfdd143e726","name":"Revoke Organization Access for a User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"UserId\": ID of User,\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/RevokeOrganizationalAccess"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Oct 2020 12:43:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"1234\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"89b7c5ec-88c5-41c9-8120-de9101a23a23"},{"name":"GetOrganizationsForUser","id":"04426fb8-de6f-4dcc-a1c6-b9509f60f102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n\t\"Id\": UserId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganizationsForUser","description":"

Allows the user to get all the organizations for the User.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","GetOrganizationsForUser"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"d82c9a49-0fda-4177-a6c6-40678d9d5f9a","name":"Check Organization Access for a User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"Credentials\": {\r\n\t\t\"UserName\": \"valid user name\",\r\n\t\t\"Password\": \"valid password\"\r\n\t},\r\n\t\"Id\": UserId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/GetOrganizationsForUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Oct 2020 12:41:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Credentials\": null,\n \"Id\": OrgId,\n \"Name\": \"MerchantGroup223\",\n \"AddressLine1\": \"129 5th Street\",\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": \"Rockledge\",\n \"State\": \"FL\",\n \"PostalCode\": \"32927\",\n \"CountryCode\": \"US\",\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\n \"PhoneNumber\": \"1234560790\",\n \"GatewayObjectId\": 12502000,\n \"OrganizationTypeId\": 4,\n \"ParentId\": OrgId,\n \"CreateDate\": \"2020-10-02T16:51:52.3\",\n \"LastUpdated\": \"2020-10-02T16:51:52.3\",\n \"LastModifiedBy\": \"bapireselleruser\",\n \"DeactivateDate\": null,\n \"IsActive\": true,\n \"Notes\": \"Created by Boarding API\",\n \"TimeZone\": \"EST5EDT\",\n \"ContactFirstName\": \"MerchantAccount\",\n \"ContactLastName\": \"ForMG\",\n \"ContactPersonalPhone\": null,\n \"ContactMobilePhone\": null,\n \"IsVisible\": false,\n \"OwnedCustomFields\": null,\n \"ActivatedCustomFields\": null,\n \"ServiceConfigurations\": null\n },\n {\n \"Credentials\": null,\n \"Id\": OrgId,\n \"Name\": \"MerchantAccount223\",\n \"AddressLine1\": \"129 5th Street\",\n \"AddressLine2\": null,\n \"AddressLine3\": null,\n \"City\": \"Rockledge\",\n \"State\": \"FL\",\n \"PostalCode\": \"32927\",\n \"CountryCode\": \"US\",\n \"EmailAddress\": \"example.boarding@bridgepaynetwork.com\",\n \"PhoneNumber\": \"1234560790\",\n \"GatewayObjectId\": 12502001,\n \"OrganizationTypeId\": 5,\n \"ParentId\": OrgId,\n \"CreateDate\": \"2020-10-02T16:51:45.113\",\n \"LastUpdated\": \"2020-10-02T16:51:57.847\",\n \"LastModifiedBy\": \"bapireselleruser\",\n \"DeactivateDate\": null,\n \"IsActive\": true,\n \"Notes\": \"Created by Boarding API\",\n \"TimeZone\": \"EST5EDT\",\n \"ContactFirstName\": \"MerchantAccount\",\n \"ContactLastName\": \"ForMG\",\n \"ContactPersonalPhone\": null,\n \"ContactMobilePhone\": null,\n \"IsVisible\": false,\n \"OwnedCustomFields\": null,\n \"ActivatedCustomFields\": null,\n \"ServiceConfigurations\": null\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List OrganizationModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 2\n}"}],"_postman_id":"04426fb8-de6f-4dcc-a1c6-b9509f60f102"}],"id":"8baaf212-9795-4f39-9046-5ab222a11bc4","description":"

User's Organizational Access can be controlled by making calls to revoke or grant access. You can also check to see which Organizations a user has access to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials
UserId	String	The ID of the user to change.
OrganizationId	String	The OrganzationId to grant or revoke.

Return ResponseModel with Success as true or false.

\n","_postman_id":"8baaf212-9795-4f39-9046-5ab222a11bc4"},{"name":"API Authentication","item":[{"name":"CreateApiAuthentication","id":"166c535f-0ec0-4173-b088-2ec4bd388e30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"ApplicationType\": \"2\",\r\n \"OrganizationId\": \"{{organizationId}}\",\r\n \"PrivateKey\": \"{{privateKey}}\",\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2035-12-25T00:00:00\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Create","description":"

The CreateApiAuthentication request is used to generate a new API Authentication Profile.

\n","urlObject":{"protocol":"https","path":["api","ApiAuthentication","Create"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0bdb1885-2827-4029-a482-91ff0a831ed9","name":"CreateApiAuthentication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"OrganizationId\": \"{{organizationId}}\",\r\n \"PrivateKey\": \"{{privateKey}}\",\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2035-12-25T00:00:00\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": \"12345\",\n \"PublicKey\": \"PublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2035-12-25T00:00:00\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ApiAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"166c535f-0ec0-4173-b088-2ec4bd388e30"},{"name":"UpdateApiAuthentication","id":"f2837681-f9dd-4c2e-97fc-4cf35d941694","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"ApplicationType\": \"2\",\r\n \"OrganizationId\": \"{{organizationId}}\",\r\n \"PublicKey\": \"{{publicApiKey}}\",\r\n \"PrivateKey\": null,\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2035-12-31T23:59:59\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Update","description":"

The UpdateApiAuthentication request is used to update an existing API Authentication Profile.

\n","urlObject":{"protocol":"https","path":["api","ApiAuthentication","Update"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"43f68afd-1ac1-49ae-a30c-a4189055f8c0","name":"UpdateApiAuthentication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"OrganizationId\": \"#####\",\r\n \"PublicKey\": \"#####\",\r\n \"PrivateKey\": null,\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2035-12-31T23:59:59\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": 12345,\n \"PublicKey\": \"PublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2035-12-31T23:59:59\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ApiAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"f2837681-f9dd-4c2e-97fc-4cf35d941694"},{"name":"GetApiAuthentication By Filter","id":"c8728f42-b0dc-41be-9d7f-c01426d06225","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"ApplicationType\": \"2\",\r\n \"OrganizationId\": {{organizationId}}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/GetByFilter","description":"

The GetApiAuthentication By Filter request is used to retrieve an existing API Authentication Profile and narrow results with a filter.

\n","urlObject":{"protocol":"https","path":["api","ApiAuthentication","GetByFilter"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"09ce4ad9-d611-44e0-8c51-7eca9fbf1bca","name":"GetApiAuthentication By Filter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"OrganizationId\": #####\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/GetByFilter"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Credentials\": null,\n \"OrganizationId\": 12345,\n \"PublicKey\": \"PublicKey1\",\n \"PrivateKey\": null,\n \"NeverExpires\": true,\n \"ExpirationDate\": null,\n \"IsActive\": true\n },\n {\n \"Credentials\": null,\n \"OrganizationId\": 12346,\n \"PublicKey\": \"PublicKey2\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2035-12-25T00:00:00\",\n \"IsActive\": true\n },\n {\n \"Credentials\": null,\n \"OrganizationId\": 12347,\n \"PublicKey\": \"PublicKey3\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2035-12-31T23:59:59\",\n \"IsActive\": true\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List\",\n \"PageSize\": 3,\n \"Page\": 1,\n \"Total\": 3\n}"}],"_postman_id":"c8728f42-b0dc-41be-9d7f-c01426d06225"},{"name":"GetApiAuthentication","id":"9bce820b-970f-4fda-a07b-1fdf108db76d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"OrganizationId\": {{organizationId}},\r\n \"PublicKey\": \"{{publicApiKey}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Get","description":"

The GetApiAuthentication request is used to retrieve an existing API Authentication Profile using the OrganizationId and PublicKey.

\n","urlObject":{"protocol":"https","path":["api","ApiAuthentication","Get"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"57d0fe67-e715-45c7-b1d0-49ec5c5c1903","name":"GetApiAuthentication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"OrganizationId\": #####,\r\n \"PublicKey\": \"#####\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Get"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": 12345,\n \"PublicKey\": \"PublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2035-12-31T23:59:59\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ApiAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"9bce820b-970f-4fda-a07b-1fdf108db76d"},{"name":"ActivateApiAuthentication","id":"c59c9e79-979d-45e8-a4f6-281463859e93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"PublicKey\": \"{{publicApiKey}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Activate","description":"

The ActivateApiAuthentication request is used to set the IsActive flag on an API Authentication Profile to true.

\n","urlObject":{"protocol":"https","path":["api","ApiAuthentication","Activate"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"1d14bc0a-4e70-4820-a53f-757de2d61ac8","name":"ActivateApiAuthentication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"PublicKey\": \"#####\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Activate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": 12345,\n \"PublicKey\": \"PublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2035-12-31T23:59:59\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ApiAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"c59c9e79-979d-45e8-a4f6-281463859e93"},{"name":"DeactivateApiAuthentication","id":"c91a041b-7fe0-47aa-97a5-be0a1cec6233","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"PublicKey\": \"{{publicApiKey}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Deactivate","description":"

The DeactivateApiAuthentication request is used to set the IsActive flag on an API Authentication Profile to false.

\n","urlObject":{"protocol":"https","path":["api","ApiAuthentication","Deactivate"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"ccfc1394-7cb1-4530-934b-213a1cff0139","name":"DeactivateApiAuthentication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"PublicKey\": \"#####\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/api/ApiAuthentication/Deactivate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": 12345,\n \"PublicKey\": \"PublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2035-12-31T23:59:59\",\n \"IsActive\": false\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"ApiAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"c91a041b-7fe0-47aa-97a5-be0a1cec6233"}],"id":"f0070f1b-22d1-40f6-bc46-d782b514b81d","description":"

The following requests are used to create and manage a public and private key pair for use with TokenPay.js or the Hosted Payment Page.

Credentials Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Description
R	UserName	string	The username with permission to configure the hosted payment page.
R	Password	string	The password for the username provided in the request.

API Authentication Request Information

The following data elements are available for use in the API Authentication requests.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Description
R	Credentials	Object	An object containing the UserName and Password for authenticating the request.
R	ApplicationType	string	A numerical value indicating the application you intend to create or update. Valid values are: 1 - TokenPay.js 2 - Hosted Payment Page
R	OrganizationId	string	A numerical value indicating the id of the merchant account on which you intend to create or update the hosted payment page.
R	PublicKey	string	A GUID generated by the gateway to be used in subsequent calls when referring to this merchant account configuration.
R	PrivateKey	string	A value generated by the integrator to be paired witht he PublicKey. Once provided in the Create request, the PrivateKey is stored in the gateway and does not need to be provided in future requests. The PrivateKey must adhere to the following guidelines: 1 Uppercase Character 1 Lowercase Character 1 Number 1 Non-Alphanumeric Character Minimum of 6 Characters
R	NeverExpires	boolean	A value indicating whether the generated key pair will never expire or if it will expire on the configured ExpirationDate.
O	ExpirationDate	string	A date indicating when the key pair should expire.
R	IsActive	boolean	A value indicating whether the key pair is activated or deactivated.

API Authentication Response Information

The following data elements are returned when using the API Authentication requests. They echo back the values provided in the request or existing for the profile. Definitions are the same as the above table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data Element	Data Type
Credentials	Object
OrganizationId	string
PublicKey	string
PrivateKey	string
NeverExpires	boolean
ExpirationDate	string
IsActive	boolean

","_postman_id":"f0070f1b-22d1-40f6-bc46-d782b514b81d"},{"name":"Custom Fields","item":[{"name":"GetCustomFieldTypes","id":"2a88e3f2-03c7-4df0-b3bb-85f5d3a7e14c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomFieldTypes","description":"

Allows the user to get all the custom field types. The ID is used in the Custom Field Model FieldTypeId. Currently there is only a 1 for string.

ReturnObject in ResponseModel: List of CustomFieldTypesResponseModel

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","GetCustomFieldTypes"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0393ffef-52a7-48ad-a053-02eb88d8a3a5","name":"GetCustomFieldTypes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomFieldTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Nov 2020 14:50:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Set-Cookie","value":"__PFV__=f8765e2ea367ab7ac837a4fc050543ae_1604328623; path=/; secure; HttpOnly; SameSite=None"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Id\": 1,\n \"Name\": \"string\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"CustomFieldTypesResponseModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"2a88e3f2-03c7-4df0-b3bb-85f5d3a7e14c"},{"name":"GetCustomizableEntities","id":"66995e9b-3ed7-4db0-b5c5-5f0661c0236e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomizableEntities","description":"

Allows the user to get all the customizable entities. this is Used in creating custom fields.

The following Entities can have custom fields included:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Entity	FieldEntityId	Notes
Transactions	1	A custom field included on a BridgeComm API transaction call.
Contract	2	A custom field included on a Recurring Billing API contract.
Wallet	3	A custom field included on a wallet.
Organization	4	A custom field included on an Organization (Reseller, Sales Agent, Group, Merchant)

ReturnObject in ResponseModel: List of CustomizableEntitiesResponseModel

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","GetCustomizableEntities"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"b8b5a82f-22fa-473a-b9e6-e81a5d480064","name":"GetCustomizableEntities","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomizableEntities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Nov 2020 14:50:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Set-Cookie","value":"__PFV__=f8765e2ea367ab7ac837a4fc050543ae_1604328640; path=/; secure; HttpOnly; SameSite=None"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Id\": 1,\n \"Name\": \"Transactions\",\n \"TableName\": \"CHARGE_TRANSACTION\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2,\n \"Name\": \"Contract\",\n \"TableName\": \"RecurringBilling.dbo.Contracts\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 3,\n \"Name\": \"Wallet\",\n \"TableName\": \"RecurringBilling.dbo.Wallet\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"CustomizableEntitiesResponseModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"66995e9b-3ed7-4db0-b5c5-5f0661c0236e"},{"name":"GetCustomFieldControlTypes","id":"9e9e4352-8e05-486d-bf61-d7725078b25e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomFieldControlTypes","description":"

Purpose: Allows the user to get a list of custom field control type IDs used for creating custom fields.

ReturnObject in ResponseModel: CustomFieldControlTypesResponseModel

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","GetCustomFieldControlTypes"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"ca64edd3-5c88-4353-a5fc-6f10671ed042","name":"GetCustomFieldControlTypes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomFieldControlTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 23 Feb 2021 19:28:52 GMT"},{"key":"Content-Length","value":"685"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Id\": 1,\n \"CustomFieldControlType\": \"TextBox\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 2,\n \"CustomFieldControlType\": \"DropDown\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 3,\n \"CustomFieldControlType\": \"CheckBox\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 4,\n \"CustomFieldControlType\": \"ListBox\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n {\n \"Id\": 5,\n \"CustomFieldControlType\": \"RadioGroup\",\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"CustomFieldControlTypesResponseModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"9e9e4352-8e05-486d-bf61-d7725078b25e"},{"name":"GetCustomField","id":"f689123e-f624-4210-9a74-c5a5b2441d5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomField","description":"

Purpose: Allows the user to get a custom field record associated with a merchant account organization.

CustomFieldModel using only the ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials
Id	Integer	The ID for the custom field.

ReturnObject in ResponseModel: CustomFieldModel

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","GetCustomField"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"a56c7c84-d8e2-4619-b9a3-1214f4a0e4af","name":"GetCustomField","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"Id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomField"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Nov 2020 14:49:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Set-Cookie","value":"__PFV__=f8765e2ea367ab7ac837a4fc050543ae_1604328541; path=/; secure; HttpOnly; SameSite=None"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Id\": 1,\n \"OrganizationId\": 8450,\n \"FieldName\": \"CustomFieldOwnedByGroup\",\n \"FieldDisplayName\": \"Our Custom Field within Transactions\",\n \"FieldRegEx\": \"[a-zA-Z0-9]\",\n \"FieldDefault\": null,\n \"SourceEntity\": null,\n \"SourceField\": null,\n \"FieldTypeId\": 1,\n \"FieldEntityId\": 1,\n \"ControlTypeId\": null,\n \"IsRequired\": false,\n \"CustomFieldActivations\": null,\n \"CustomFieldControlType\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"CustomFieldModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"f689123e-f624-4210-9a74-c5a5b2441d5b"},{"name":"GetCustomFieldsByFilter","id":"9b194774-c17c-40f5-9cd7-981b016ff796","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n } ,\r\n \"CustomFieldFilter\": {\r\n //\"OrganizationId\": 8451\r\n //\"FieldName\": \"PATIENT_NAME\"\r\n \"IsRequired\": false\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomFieldsByFilter","description":"

Allows the user to get a list of Custom Fields based on filter criteria.

CustomFieldFilterModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials	Used only for Create/Update/Get.
Id	Integer	The ID for the custom field.
FieldName	Nullable String	The name of the field.
OrganizationId	Integer	The Organization ID for the Merchant Account.

ReturnObject in ResponseModel: List of CustomFieldModel

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","GetCustomFieldsByFilter"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"3a2fbb93-190c-4a8a-8c4d-c432650e6f38","name":"GetCustomFieldsByFilter","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n } ,\r\n \"CustomFieldFilter\": {\r\n \"OrganizationId\": 8450\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/GetCustomFieldsByFilter"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Nov 2020 14:49:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Set-Cookie","value":"__PFV__=f8765e2ea367ab7ac837a4fc050543ae_1604328593; path=/; secure; HttpOnly; SameSite=None"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Id\": 1,\n \"OrganizationId\": 8450,\n \"FieldName\": \"CustomFieldOwnedByGroup\",\n \"FieldDisplayName\": \"Our Custom Field within Transactions\",\n \"FieldRegEx\": \"[a-zA-Z0-9]\",\n \"FieldDefault\": null,\n \"SourceEntity\": null,\n \"SourceField\": null,\n \"FieldTypeId\": 1,\n \"FieldEntityId\": 1,\n \"ControlTypeId\": null,\n \"IsRequired\": false,\n \"CustomFieldActivations\": null,\n \"CustomFieldControlType\": null,\n \"ObjectState\": 0,\n \"Messages\": [],\n \"DataSourceResponses\": []\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List CustomFieldModel\",\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 1\n}"}],"_postman_id":"9b194774-c17c-40f5-9cd7-981b016ff796"},{"name":"CreateCustomField","id":"e46308e4-7e52-4fde-9a2f-712be13f0895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"CustomField\": {\r\n \"OrganizationId\": 8450,\r\n \"FieldName\": \"CustomFieldOwnedByGroup\",\r\n \"FieldDisplayName\": \"Our Custom Field within Transactions\",\r\n \"FieldRegex\": \"[a-zA-Z0-9]\",\r\n \"FieldTypeId\": 1,\r\n \"FieldEntityId\": 1,\r\n \"ControlTypeId\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/CreateCustomField","description":"

Purpose: Allows the user to create a Custom Field for an organization.

CustomFieldModel

Property Name	Required	Type	Min	Max	Notes
Credentials	Yes	Credentials
Id	Response Only	Integer	1	10	Returned ID for the custom field.
OrganizationId	Yes	Integer	1	10	The Organization ID that will own the custom field. Cannot be updated after creation.
FieldName	Yes	Nullable String	2	40	The name of the field.
FieldDisplayName	Yes	Nullable String	2	40	The display name of the field.
FieldRegEx	No	Nullable String			The regular expression of the field.
FieldDefault	No	Nullable String			The default of the field.
SourceEntity	No	Nullable String			The source of the entity.
SourceField	No				The source of a field.
FieldTypeId	Yes	Integer			The Type ID of the field (see GetCustomFieldTypes). Cannot be updated after creation.
FieldEntityId	Yes	Integer			The Entity ID of the field (see GetCustomizableEntities). Cannot be updated after creation.
ControlTypeId	No				The ControlType ID of the field (see GetCustomFieldControlTypes).
IsRequired	No				Determines if Field is required or not.
ActivateOnCreate	No	boolean			Determines whether the field will be active upon creation. If not provided, custom field will be inactive upon creation.
CustomFieldActivations	Response Only
CustomFieldControlType	Response Only
ObjectState	Response Only
Messages	Response Only
DataSourceResponses	Response Only

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","CreateCustomField"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"f49f344d-a26c-4b28-b1ea-860685436ec1","name":"Create a New Custom Field","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"CustomField\": {\r\n \"OrganizationId\": ExampleMerchantGroupId,\r\n \"FieldName\": \"CustomFieldOwnedByGroup\",\r\n \"FieldDisplayName\": \"Our Custom Field within Transactions\",\r\n \"FieldRegex\": \"[a-zA-Z0-9]\",\r\n \"FieldTypeId\": 1,\r\n \"FieldEntityId\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/CreateCustomField"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Oct 2020 21:40:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"1\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"e46308e4-7e52-4fde-9a2f-712be13f0895"},{"name":"UpdateCustomField","id":"498737f5-c6b7-47aa-a57c-e288a3a45701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"CustomField\": {\r\n \"Id\": 1,\r\n \"FieldName\": \"CustomFieldOwnedByGroup\",\r\n \"FieldDisplayName\": \"Our Custom Field within Transactions\",\r\n \"FieldRegex\": \"[a-zA-Z0-9]\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/UpdateCustomField","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","UpdateCustomField"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"6aef6724-ae6c-465d-acbc-dac743aedefb","name":"UpdateCustomField","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"CustomField\": {\r\n \"Id\": 1,\r\n \"FieldDisplayName\": \"The Custom Field within our Transactions\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/UpdateCustomField"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Nov 2020 16:57:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Set-Cookie","value":"__PFV__=f8765e2ea367ab7ac837a4fc050543ae_1604336260; path=/; secure; HttpOnly; SameSite=None"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"498737f5-c6b7-47aa-a57c-e288a3a45701"},{"name":"ActivateCustomField","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","\r","pm.test(\"CustomField Linked\", function () {\r"," pm.expect(jsonData.Success).to.eql(true);\r","});"],"type":"text/javascript","id":"77034a52-fb9e-43b4-84f5-ba518a91bf9f"}}],"id":"6b6f85f8-e2c8-4521-a7d1-69e9d62d2a6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"CustomFieldActivation\": {\r\n \"CustomFieldConfigId\": 1,\r\n \"OrganizationId\": 8451\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/ActivateCustomField","description":"

Allows the user to activate a Custom Field for an organization.

The Custom field created at a higher level in a hierarchy can be activated on the same level in the hierarchy or lower.

CustomFieldModel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Type	Notes
Credentials	Credentials
CustomFieldConfigId	Integer	The ID for the custom field to activate.
OrganizationId	Integer	The Organization ID where the custom field will be active.

Return ResponseModel with Success as true or false.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","ActivateCustomField"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"e97a4240-7d0c-48fa-84cf-01fec09efaa5","name":"Activate an Existing Custom Field for a Merchant","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"CustomFieldActivation\": {\r\n \"CustomFieldConfigId\": 1,\r\n \"OrganizationId\": 8451\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/ActivateCustomField"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Nov 2020 14:52:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self';"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"Set-Cookie","value":"__PFV__=f8765e2ea367ab7ac837a4fc050543ae_1604328752; path=/; secure; HttpOnly; SameSite=None"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"6b6f85f8-e2c8-4521-a7d1-69e9d62d2a6a"},{"name":"DeactivateCustomField","id":"197f102d-708b-4160-8639-7d9b27542b7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"CustomFieldActivation\": {\r\n \"CustomFieldConfigId\": 1,\r\n \"OrganizationId\": 8451\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/CustomField/DeactivateCustomField","urlObject":{"protocol":"https","path":["Boarding.API","api","CustomField","DeactivateCustomField"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"197f102d-708b-4160-8639-7d9b27542b7f"}],"id":"35417e88-7594-4df5-bb3a-688fef3aee28","description":"

This section Describes how to retrieve, create, update, activate, and deactivate Custom Fields. Only Bridgepay approved entities can add Custom Fields.

Custom Fields must be created at an Organization level within the Organizational Hierarchy. It is recommended that a field which will be used throughout an organization be created at the highest level that would be appropriate.

For instance, if a field named \"Patient_Name\" would be used across multiple Merchant Groups, The field should be created at the Reseller level. This would allow management of the field attributes to occur in one location. If a field is very specific to a set of Merchant Groups and not all Merchant Groups need that field, the field should be created for the specific Merchant Group organization.

Custom Fields created on the Reseller level do not apply to Sales Agents. When using Custom Fields with Sales Agents, consider the Sales Agent the highest point in the hierarchy.

The organization where the field is created becomes the field owner.

In order to use the field with an organization, it must be activated for that organization.

Note that Custom Field Names must conform to XML standards and as such cannot contain spaces or commas. If a name does not pass the validation, the API will return an error stating that the FieldName contains invalid characters.

\n","_postman_id":"35417e88-7594-4df5-bb3a-688fef3aee28"},{"name":"Appendix","item":[{"name":"A.1 Time Zone Values","item":[],"id":"9d49ca46-3ce0-491f-ac15-2ca6b98d369a","description":"

The following table displays the possible time zones that can be applied durring the boarding process.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Time Zone	Time Zone Code
Eastern Time	EST5EDT
Central Time	CST6CDT
Mountain Time	MST7MDT
Pacific Time	PST8PDT
Newfoundland Time	NST3:30NDT
Atlantic Time	AST4ADT
Hawaii-Aleutian Time	HAST10HADT
Alaskan Time	AKST9AKDT

","_postman_id":"9d49ca46-3ce0-491f-ac15-2ca6b98d369a"},{"name":"A.2 Processor Profile Setup Information","item":[{"name":"cards-realtime/proxy","id":"0fbd1172-ee38-4a98-a2ce-bf11d711b353","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/proxy\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"isConvenienceFeeEnabled\",\r\n \"Value\": \"True\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"isTokenizationRequired\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Regex Pattern	Default	Notes
AccountProcessingPolicy	YES	8	8	N/A	VMDX----	Determines what card types are accepted.
IsConvenienceFeeEnabled	NO	N/A	N/A	N/A	False	Turns on/off processing convenience fees.
IsTokenizationRequired	NO	N/A	N/A	N/A	False	Not Used.

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

There are no specific DataElements as part of creating an ach/proxy profile.

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"caa53012-e06b-4454-b566-0596d337fa1a","name":"ach/proxy","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"ach/proxy\",\r\n \"DataElements\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 02 Mar 2021 20:42:45 GMT"},{"key":"Content-Length","value":"161"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ach/proxy\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"3bcafff7-5573-4426-873d-bad0aa550b4f"},{"name":"cards-realtime/tsys","id":"fed17dac-7077-4100-9395-ccd4ba5127b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/tsys\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"merchantNumber\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantName\",\r\n \"Value\": \"THIS NAME UP TO 25 CHAR\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCode\",\r\n \"Value\": \"8021\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"city\",\r\n \"Value\": \"FORT ATKINSON\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"cityCode\",\r\n \"Value\": \"53538\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"state\",\r\n \"Value\": \"WI\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"contactPhone\",\r\n \"Value\": \"8885551212\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"timeZone\",\r\n \"Value\": \"706\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"acquirerBin\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentBankNumber\",\r\n \"Value\": \"000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentChainNumber\",\r\n \"Value\": \"000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"storeNumber\",\r\n \"Value\": \"0001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumber\",\r\n \"Value\": \"0006\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantLocationNumber\",\r\n \"Value\": \"00001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantAbaNumber\",\r\n \"Value\": \"000000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantSettlementAgentNumber\",\r\n \"Value\": \"V000\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"sharingGroups\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"vatRegistrationNumber\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalId\",\r\n \"Value\": \"70392760\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"fcsId\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"isDebitCardProcessingEnabled\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Property Name	Required	Min	Max	Reg Ex	Default	Notes
merchantNumber	YES	4	12	N/A	NULL
merchantName	YES	4	25	N/A	NULL
merchantCategoryCode	YES	N/A	4	N/A	NULL
city	YES	N/A	13	N/A	NULL
cityCode	YES	N/A	9	N/A	NULL
state	YES	N/A	2	N/A	NULL
contactPhone	YES	N/A	10	N/A	NULL
timeZone	YES	3	3	Numeric	NULL	\"705\" - EST \"706\" - CST \"707\" - MST \"708\" - PST Includ only the numeric portion. Do not include the EST/CST/MST/PST.
acquirerBin	YES	N/A	6	N/A	NULL
agentBankNumber	YES	N/A	6	N/A	NULL
agentChainNumber	YES	N/A	6	N/A	NULL
storeNumber	YES	N/A	4	N/A	NULL
terminalNumber	YES	N/A	4	N/A	NULL
merchantLocationNumber	YES	N/A	5	N/A	NULL
merchantAbaNumber	NO	N/A	255	N/A	NULL
merchantSettlementAgentNumber	NO	N/A	4	N/A	NULL
sharingGroups	NO	N/A	30	N/A	NULL
vatRegistrationNumber	NO	N/A	20	N/A	NULL
terminalId	YES	N/A	8	N/A	NULL
accountProcessingPolicy	YES	8	8	N/A	VMXD----
fcsId	NO	1	7	N/A	NULL
isDebitCardProcessingEnabled	YES	N/A	N/A	N/A	False

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"21263bc0-35c3-497d-b23c-6052ab0caa4b","name":"CreateProfile cards-realtime/tsys","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/tsys\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"merchantNumber\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantName\",\r\n \"Value\": \"THIS NAME UP TO 25 CHAR\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCode\",\r\n \"Value\": \"8021\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"city\",\r\n \"Value\": \"FORT ATKINSON\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"cityCode\",\r\n \"Value\": \"53538\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"state\",\r\n \"Value\": \"WI\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"contactPhone\",\r\n \"Value\": \"8885551212\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"timeZone\",\r\n \"Value\": \"706\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"acquirerBin\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentBankNumber\",\r\n \"Value\": \"000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentChainNumber\",\r\n \"Value\": \"000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"storeNumber\",\r\n \"Value\": \"0001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumber\",\r\n \"Value\": \"0006\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantLocationNumber\",\r\n \"Value\": \"00001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantAbaNumber\",\r\n \"Value\": \"000000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantSettlementAgentNumber\",\r\n \"Value\": \"V000\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"sharingGroups\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"vatRegistrationNumber\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalId\",\r\n \"Value\": \"70392760\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"fcsId\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"isDebitCardProcessingEnabled\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 02 Mar 2021 19:10:20 GMT"},{"key":"Content-Length","value":"171"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"cards-realtime/tsys\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"fed17dac-7077-4100-9395-ccd4ba5127b8"},{"name":"cards-realtime/firstdata-rapidconnect","id":"fe9f0ef7-e84e-4cd1-919b-3f19150c9969","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"//Lodging Merchant information - Only used when BridgeComm API Transaction includes LD\r\n{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/firstdata-rapidconnect\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"isDebitCardProcessingEnabled\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"merchantName\",\r\n \"Value\": \"UP TO 19 LENGTH\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantStreet\",\r\n \"Value\": \"127 PUBLIC SQUARE\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantState\",\r\n \"Value\": \"TX\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCity\",\r\n \"Value\": \"Dallas\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantZip\",\r\n \"Value\": \"75220\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCountry\",\r\n \"Value\": \"USA\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"countryCode\",\r\n \"Value\": \"US\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"customerServicePhoneNumber\",\r\n \"Value\": \"8885551212\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"fnsNumber\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"alternateMerchantId\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"chargeDescription\",\r\n \"Value\": \"TEST MERCHANT\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"retailMerchantCategoryCode\",\r\n \"Value\": \"6010\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRetail\",\r\n \"Value\": \"555500000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdRetail\",\r\n \"Value\": \"7654321\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRetailSettlement\",\r\n \"Value\": \"55550000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"motoMerchantCategoryCode\",\r\n \"Value\": \"6010\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdMoto\",\r\n \"Value\": \"555500000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdMoto\",\r\n \"Value\": \"7654321\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdMotoSettlement\",\r\n \"Value\": \"555500000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"restaurantMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRestaurant\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdRestaurant\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRestaurantSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"lodgingMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdLodging\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdLodging\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdLodgingSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"ecommUrl\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"ecommerceMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdEcommerce\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdEcommerce\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdEcommerceSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"carRentalMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdCarRental\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdCarRental\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdCarRentalSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Rapid Connect has multiple industry fields present, not all industries are required to be configured. Only fill in the industry fields which will be processing transactions, what goes into BridgeComm in the TransIndustryType field will determine which boarded information is used. If using the Virtual Terminal in MyBridgePay, fill in the moto fields.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default	Notes
accountProcessingPolicy	YES	8	8	N/A	VMXD----
isDebitCardProcessingEnabled	YES	N/A	N/A	N/A	False
merchantName	YES	N/A	19	N/A	NULL
merchantStreet	YES	N/A	20	N/A	NULL
merchantState	YES	N/A	2	N/A	NULL
merchantCity	YES	N/A	13	N/A	NULL
merchantZip	YES	N/A	9	N/A	NULL
merchantCountry	YES	N/A	3	N/A	NULL	USA
countryCode	YES	N/A	2	N/A	NULL	US
customerServicePhoneNumber	NO	N/A	10	N/A	NULL
fnsNumber	NO	1	7	N/A	NULL
alternateMerchantId	NO	N/A	15	N/A	NULL
chargeDescription	YES	N/A	23	N/A	NULL
retailMerchantCategoryCode	YES	N/A	4	N/A	NULL	TransIndustryType=RE
merchantIdRetail	YES	N/A	12	N/A	NULL	TransIndustryType=RE The 12 Digit North Merchant ID
terminalIdRetail	YES	N/A	8	N/A	NULL	TransIndustryType=RE
merchantIdRetailSettlement	YES	N/A	16	N/A	NULL	TransIndustryType=RE
motoMerchantCategoryCode	YES	N/A	4	N/A	NULL	TransIndustryType=DM
merchantIdMoto	YES	N/A	12	N/A	NULL	TransIndustryType=DM The 12 Digit North Merchant ID
terminalIdMoto	YES	N/A	8	N/A	NULL	TransIndustryType=DM
merchantIdMotoSettlement	YES	N/A	16	N/A	NULL	TransIndustryType=DM
restaurantMerchantCategoryCode	YES	N/A	4	N/A	NULL	TransIndustryType=RS
merchantIdRestuarant	YES	N/A	12	N/A	NULL	TransIndustryType=RS The 12 Digit North Merchant ID
terminalIdRestuarant	YES	N/A	8	N/A	NULL	TransIndustryType=RS
merchantIdRestuarantSettlement	YES	N/A	16	N/A	NULL	TransIndustryType=RS
lodgingMerchantCategoryCode	YES	N/A	4	N/A	NULL	TransIndustryType=LD
merchantIdLodging	YES	N/A	12	N/A	NULL	TransIndustryType=LD The 12 Digit North Merchant ID
terminalIdLodging	YES	N/A	8	N/A	NULL	TransIndustryType=LD
merchantIdLodgingSettlement	YES	N/A	16	N/A	NULL	TransIndustryType=LD
ecommUrl	NO*	N/A	25	N/A	NULL	TransIndustryType=EC Required Field if Using other Ecomm Fields
ecommerceMerchantCategoryCode	NO	N/A	4	N/A	NULL	TransIndustryType=EC
merchantIdEcommerce	NO	N/A	12	N/A	NULL	TransIndustryType=EC The 12 Digit North Merchant ID
terminalIdEcommerce	NO	N/A	8	N/A	NULL	TransIndustryType=EC
merchantIdEcommerceSettlement	NO	N/A	16	N/A	NULL	TransIndustryType=EC
carRentalMerchantCategoryCode	NO	N/A	4	N/A	NULL	TransIndustryType=CR
merchantIdCarRental	NO	N/A	12	N/A	NULL	TransIndustryType=CR The 12 Digit North Merchant ID
terminalIdCarRental	NO	N/A	8	N/A	NULL	TransIndustryType=CR
merchantIdCarRentalSettlement	NO	N/A	16	N/A	NULL	TransIndustryType=CR

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"19d68430-c8d0-4655-9fdb-53d3ab2dbcd4","name":"CreateProfile cards-realtime/firstdata-rapidconnect","originalRequest":{"method":"POST","header":[{"key":"Accept-Encoding","value":"gzip, deflate","type":"text","disabled":true},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text","disabled":true}],"body":{"mode":"raw","raw":"//Lodging Merchant information - Only used when BridgeComm API Transaction includes LD\r\n{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/firstdata-rapidconnect\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"isDebitCardProcessingEnabled\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"merchantName\",\r\n \"Value\": \"UP TO 19 LENGTH\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantStreet\",\r\n \"Value\": \"127 PUBLIC SQUARE\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantState\",\r\n \"Value\": \"TX\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCity\",\r\n \"Value\": \"Dallas\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantZip\",\r\n \"Value\": \"75220\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCountry\",\r\n \"Value\": \"USA\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"countryCode\",\r\n \"Value\": \"US\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"customerServicePhoneNumber\",\r\n \"Value\": \"8885551212\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"fnsNumber\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"alternateMerchantId\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"chargeDescription\",\r\n \"Value\": \"TEST MERCHANT\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"retailMerchantCategoryCode\",\r\n \"Value\": \"6010\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRetail\",\r\n \"Value\": \"555500000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdRetail\",\r\n \"Value\": \"7654321\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRetailSettlement\",\r\n \"Value\": \"55550000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"motoMerchantCategoryCode\",\r\n \"Value\": \"6010\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdMoto\",\r\n \"Value\": \"555500000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdMoto\",\r\n \"Value\": \"7654321\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdMotoSettlement\",\r\n \"Value\": \"555500000999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"restaurantMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRestaurant\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdRestaurant\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRestaurantSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"lodgingMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdLodging\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdLodging\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdLodgingSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"ecommUrl\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"ecommerceMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdEcommerce\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdEcommerce\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdEcommerceSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"carRentalMerchantCategoryCode\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdCarRental\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdCarRental\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdCarRentalSettlement\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 02 Mar 2021 20:16:29 GMT"},{"key":"Content-Length","value":"189"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"cards-realtime/firstdata-rapidconnect\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"fe9f0ef7-e84e-4cd1-919b-3f19150c9969"},{"name":"cards-realtime/firstdata-omaha","id":"360624c1-b858-4baa-a6eb-41fe7539f00b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/firstdata-omaha\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantId\",\r\n \"Value\": \"1234567890123456789\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Regex Pattern	Default	Notes
AccountProcessingPolicy	YES	8	8	N/A	VMDX----	Determines what card types are accepted.
merchantId	YES	4	19	N/A	False

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Regex Pattern	Default
StoreId	YES			N
StoreKey	YES	1	100	^[0-9A-Za-z-.\\\\u0020/\\\\\\\\_+-=)(&^%$#@!<>~]$
EntityId	YES	1	2147483647	N
LocationId	YES	0	2147483647	N
AuthorizationCurrencyCode	YES	1	3	^(EUR	USD)$
CaptureCurrencyCode	YES	1	3
IsCreditEnabled	YES	0	3	N

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default
isCreditEnabled	YES	N/A	N/A	N/A	True
storeId	YES	N/A	15	N/A	NULL
storeKey	YES	N/A	100	N/A	NULL
entityId	YES	N/A	15	N/A	NULL
locationId	YES	N/A	15	N/A	NULL
authorizationCurrencyCode	YES	N/A	N/A	N/A	USD
captureCurrencyCode	YES	N/A	N/A	N/A	USD

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

Property Name	Required	Min	Max	Reg Ex	Default	Notes
clientId	YES	4	4	N/A	NULL
merchantId	YES	12	12	N/A	NULL
terminalIdRetail	NO	3	3	N/A	NULL
terminalIdRestaurant	NO	3	3	N/A	NULL
terminalIdMoto	NO	3	3	N/A	NULL
terminalIdEcommerce	NO	3	3	N/A	NULL
username	YES	N/A	32	N/A	NULL
password	YES	N/A	50	N/A	NULL
settlementMode	YES	N/A	N/A	N/A	TR	TR, HT, or HM
accountProcessingPolicy	YES	8	8	N/A	VMXD----
settlementType	NO	N/A	N/A	N/A	NULL
settlementMode	NO	N/A	N/A	N/A	NULL	Terminal or Host

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

Property Name	Required	Min	Max	Reg Ex	Default	Notes
acquirerInstitutionId	YES	4	4	N/A	NULL
merchantIdEcommerce	NO	4	12	N/A	NULL
merchantIdMoto	NO	N/A	12	N/A	NULL
merchantIdRestaurant	NO	N/A	12	N/A	NULL
merchantIdRetail	NO	N/A	12	N/A	NULL
networkRouting	YES	N/A	6	N/A	NULL
password	YES	N/A	50	N/A	NULL
terminalIdEcommerce	NO	N/A	3	N/A	NULL
terminalIdMoto	NO	N/A	3	N/A	NULL
terminalIdRestaurant	NO	N/A	3	N/A	NULL
terminalIdRetail	NO	N/A	3	N/A	NULL
username	YES	N/A	50	N/A	NULL
accountProcessingPolicy	YES	8	8	N/A	VMXD----
isSettlmentInitiationRequired	NO	N/A	N/A	N/A	NULL	Indicates whether settlements have to be explicitly initiated by the gateway.
settlementMode	YES	N/A	N/A	N/A	NULL	HT = Host based time initiated HM = Host based merchant initiated

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9d56f857-e7a6-4417-bb27-b2e55aca998e","name":"cards-realtime/vantiv-tandem","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/vantiv-tandem\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"AcquirerInstitutionID\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"MerchantIdEcommerce\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"MerchantIdMoto\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"MerchantIdRestaurant\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"MerchantIdRetail\",\r\n \"Value\": \"123009876543\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"NetworkRouting\",\r\n \"Value\": \"K1\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"password\",\r\n \"Value\": \"1234567G\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"TerminalIdEcommerce\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"TerminalIdRestaurant\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"TerminalIdRetail\",\r\n \"Value\": \"001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"username\",\r\n \"Value\": \"1234TTT1\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"TerminalIdMoto\",\r\n \"Value\": null,\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"AccountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"IsSettlementInitationRequired\",\r\n \"Value\": \"False\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"SettlementMode\",\r\n \"Value\": \"HM\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 02 Mar 2021 21:56:48 GMT"},{"key":"Content-Length","value":"180"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"cards-realtime/vantiv-tandem\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"1ddb7ec5-8aa0-4009-9fc9-c12ba362043b"},{"name":"cards-realtime/mastercard-mngs","id":"78688604-1ebc-4ac9-a2f1-dc38d4987b27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\"\r\n },\r\n \"OrganizationId\": {{merchantOrgID}},\r\n \"Type\": \"cards-realtime/mastercard-mngs\",\r\n \"IsActive\": false,\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"acquiringInstitutionIdCode\",\r\n \"Value\": \"59400012698\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"preAuthLifeCycle\",\r\n \"Value\": \"1\",\r\n \"DataType\": \"Int32\"\r\n },\r\n {\r\n \"Name\": \"preAuthLifeCycleTimeUnit\",\r\n \"Value\": \"1\",\r\n \"DataType\": \"Int32\"\r\n },\r\n {\r\n \"Name\": \"customerServicePhoneNumber\",\r\n \"Value\": \"5555555555\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"forwardingInstitutionIdCode\",\r\n \"Value\": \"10000000002\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCode\",\r\n \"Value\": \"5999\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCity\",\r\n \"Value\": \"1\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantName\",\r\n \"Value\": \"Ranorex\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantId\",\r\n \"Value\": \"10000000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantPostalCode\",\r\n \"Value\": \"32810\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantState\",\r\n \"Value\": \"FL\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantStreet\",\r\n \"Value\": \"234 Main Street\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXD---B\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"sponsorBankId\",\r\n \"Value\": \"023456789\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalId\",\r\n \"Value\": \"10000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"acquiringBin\",\r\n \"Value\": \"test\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"atmMerchantType\",\r\n \"Value\": \"false\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"cashOnlyAtmMerchantType\",\r\n \"Value\": \"false\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"connectionMode\",\r\n \"Value\": \"VPN\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"connectionType\",\r\n \"Value\": \"MASTER\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"contactPhoneNumber\",\r\n \"Value\": \"88888888\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"dataCaptureProviderBin\",\r\n \"Value\": \"10000001\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"debitReversalExpirationTimeInMin\",\r\n \"Value\": \"2\",\r\n \"DataType\": \"Int32\"\r\n },\r\n {\r\n \"Name\": \"descriptor\",\r\n \"Value\": \"test\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"isSendCreditAuthorization\",\r\n \"Value\": \"false\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"isCreditEnabled\",\r\n \"Value\": \"false\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"isDebitCardProcessingEnabled\",\r\n \"Value\": \"true\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"isSendVoidAuthorization\",\r\n \"Value\": \"true\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"isSendVoidCredit\",\r\n \"Value\": \"true\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"RefundMaxSingleDollarAmount\",\r\n \"Value\": \"25\",\r\n \"DataType\": \"Int64\"\r\n },\r\n {\r\n \"Name\": \"SaleMaxSingleDollarAmount\",\r\n \"Value\": \"25\",\r\n \"DataType\": \"Int64\"\r\n },\r\n {\r\n \"Name\": \"RefundRollingDollarVolume\",\r\n \"Value\": \"25\",\r\n \"DataType\": \"Int64\"\r\n },\r\n {\r\n \"Name\": \"isTokenizationRequired\",\r\n \"Value\": \"10000001\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Property Name	Required	Min	Max	DataType	Notes
acquirerInstitutionId1	R	1	11	String
preAuthLifeCycle	O	1	2	Int32
preAuthLifeCycleTimeUnit	O	1	1	Int32	Enumerated Values are: 1 2 3
customerServicePhoneNumber	R	1	10	String
forwardingInstitutionIdCode	R	1	11	String
merchantCategoryCode	R	1	4	String
merchantCity	R	1	50	String
merchantName	R	1	25	String
merchantId	R	1	15	String
merchantPostalCode	R	5	9	String
merchantState	R	2	2	String
merchantStreet	R	1	50	String
accountProcessingPolicy	R	8	8	String	VMXD---B
sponsorBankId	O	9	11	String
terminalId	R	1	10	String
acquiringBin	O	1	10	String
contactPhoneNumber	O	1	10	String
descriptor	R	1	25	String
refundMaxSingleDollarAmount	O	0	19	Int64
refundRollingDollarVolume	O	0	19	Int64
saleMaxSingleDollarAmount	O	0	19	Int64
saleRollingRollarVolume	O	0	19	Int64
timeZone	O

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default
terminalIdCCD	NO	N/A	7	N/A	NULL
terminalIdPOP	NO	N/A	7	N/A	NULL
terminalIdPPD	NO	N/A	7	N/A	NULL
terminalIdTEL	NO	N/A	7	N/A	NULL
terminalIdWEB	NO	N/A	7	N/A	NULL
terminalIdCheck21	NO	N/A	7	N/A	NULL

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default
siteId	YES	N/A	5	N/A	NULL
merchantId	YES	N/A	6	N/A	NULL
username	YES	N/A	50	N/A	NULL
password	YES	N/A	255	N/A	NULL

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"5ea675f3-b9b9-47dc-99b8-61f8b9986fcf","name":"ach/t-tech","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"ach/t-tech\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"siteId\",\r\n \"Value\": \"12345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantId\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"username\",\r\n \"Value\": \"12345678901234567890123456789012345678901234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"password\",\r\n \"Value\": \"123456789012345678901234567890123456789012345678901234567890\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 04 Mar 2021 13:38:08 GMT"},{"key":"Content-Length","value":"162"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"ach/t-tech\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"bd3dfae2-e052-4ff6-9ccc-a92160bc7729"},{"name":"cards-realtime/elavon-viaconex4","id":"38237bad-97e9-48dc-a0a9-c88026ffa3d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/elavon-viaconex4\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"bankNumber\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"customerServicePhone\",\r\n \"Value\": \"1234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"descriptor\",\r\n \"Value\": \"123456789012345678901\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"descriptorPrefix\",\r\n \"Value\": \"123\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"institutionName\",\r\n \"Value\": \"1234567890123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantName\",\r\n \"Value\": \"1234567890123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantStreetAddress\",\r\n \"Value\": \"123456789012345678901234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCity\",\r\n \"Value\": \"1234567890123\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantState\",\r\n \"Value\": \"FL\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantZip\",\r\n \"Value\": \"123456789\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCountry\",\r\n \"Value\": \"US\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRetail\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRestaurant\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdMoto\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdEcommerce\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberRetail\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberRestaurant\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberMoto\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberEcommerce\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"vendorId\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Property Name	Required	Min	Max	Reg Ex	Default
accountProcessingPolicy	YES	8	8	N/A	VMXD----
bankNumber	YES	1	6	N/A	NULL
customerServicePhone	YES	N/A	10	N/A	NULL
descriptor	NO	N/A	21	N/A	NULL
descriptorPrefix	NO	N/A	3	N/A	NULL
institutionName	YES	N/A	25	N/A	NULL
merchantName	YES	N/A	25	N/A	NULL
merchantStreetAddress	YES	N/A	30	N/A	NULL
merchantCity	YES	N/A	13	N/A	NULL
merchantState	YES	N/A	2	N/A	NULL
merchantZip	YES	N/A	9	N/A	NULL
merchantCountry	YES	N/A	2	N/A	NULL
merchantIdRetail	NO	N/A	15	N/A	NULL
merchantIdRestaurant	NO	N/A	15	N/A	NULL
merchantIdMoto	NO	N/A	15	N/A	NULL
merchantIdEcommerce	NO	N/A	15	N/A	NULL
terminalNumberRetail	NO	N/A	16	N/A	NULL
terminalNumberRestaurant	NO	N/A	16	N/A	NULL
terminalNumberMoto	NO	N/A	16	N/A	NULL
terminalNumberEcommerce	NO	N/A	16	N/A	NULL
vendorId	YES	N/A	4	N/A	NULL

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9a9d1a09-88da-47aa-934e-ca9b38380123","name":"cards-realtime/elavon-viaconex4","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/elavon-viaconex4\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"bankNumber\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"customerServicePhone\",\r\n \"Value\": \"1234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"descriptor\",\r\n \"Value\": \"123456789012345678901\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"descriptorPrefix\",\r\n \"Value\": \"123\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"institutionName\",\r\n \"Value\": \"1234567890123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantName\",\r\n \"Value\": \"1234567890123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantStreetAddress\",\r\n \"Value\": \"123456789012345678901234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCity\",\r\n \"Value\": \"1234567890123\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantState\",\r\n \"Value\": \"FL\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantZip\",\r\n \"Value\": \"123456789\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCountry\",\r\n \"Value\": \"US\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRetail\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdRestaurant\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdMoto\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantIdEcommerce\",\r\n \"Value\": \"123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberRetail\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberRestaurant\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberMoto\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumberEcommerce\",\r\n \"Value\": \"1234567890123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"vendorId\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 09 Mar 2021 20:05:21 GMT"},{"key":"Content-Length","value":"183"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"cards-realtime/elavon-viaconex4\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"38237bad-97e9-48dc-a0a9-c88026ffa3d7"},{"name":"cards-realtime/heartland-exchange","id":"d603e4f9-9580-4141-9fb3-38acb9842e55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/heartland-exchange\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"acquirerBin\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentBankNumber\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentChainNumber\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"city\",\r\n \"Value\": \"1234567890123\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"cityCode\",\r\n \"Value\": \"123456789\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"contactPhoneNumber\",\r\n \"Value\": \"1234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"developerId\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeEcommerce\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeMoto\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeRestaurant\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeRetail\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberEcommerce\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberMoto\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberRestaurant\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberRetail\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"name\",\r\n \"Value\": \"1234567890123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"state\",\r\n \"Value\": \"FL\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"storeNumber\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberEcommerce\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberMoto\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberRestaurant\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberRetail\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumber\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"timeZone\",\r\n \"Value\": \"706\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"versionId\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantLocationNumber\",\r\n \"Value\": \"12345\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Property Name	Required	Min	Max	Reg Ex	Default
accountProcessingPolicy	YES	8	8	N/A	VMXD----
acquirerBin	YES	N/A	6	N/A	NULL
agentBankNumber	YES	N/A	6	N/A	NULL
agentChainNumber	YES	N/A	6	N/A	NULL
city	YES	N/A	13	N/A	NULL
cityCode	YES	N/A	9	N/A	NULL
contactPhoneNumber	YES	N/A	10	N/A	NULL
developerId	YES	N/A	6	N/A	NULL
merchantCategoryCodeEcommerce	NO	N/A	4	N/A	NULL
merchantCategoryCodeMoto	NO	N/A	4	N/A	NULL
merchantCategoryCodeRestaurant	NO	N/A	4	N/A	NULL
merchantCategoryCodeRetail	NO	N/A	4	N/A	NULL
merchantNumberEcommerce	NO	N/A	12	N/A	NULL
merchantNumberMoto	NO	N/A	12	N/A	NULL
merchantNumberRestaurant	NO	N/A	12	N/A	NULL
merchantNumberRetail	NO	N/A	12	N/A	NULL
name	YES	N/A	25	N/A	NULL
state	YES	N/A	2	N/A	NULL
storeNumber	YES	N/A	4	N/A	NULL
terminalIdNumberEcommerce	NO	N/A	8	N/A	NULL
terminalIdNumberMoto	NO	N/A	8	N/A	NULL
terminalIdNumberRestaurant	NO	N/A	8	N/A	NULL
terminalIdNumberRetail	NO	N/A	8	N/A	NULL
terminalNumber	YES	N/A	4	N/A	NULL
timeZone	YES	N/A	3	N/A	NULL
versionId	YES	N/A	4	N/A	NULL
merchantLocationNumber	YES	N/A	5	N/A	NULL

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"32b04659-4c71-4508-9fc9-c6cf4dfef153","name":"cards-realtime/heartland-exchange","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/heartland-exchange\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"acquirerBin\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentBankNumber\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"agentChainNumber\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"city\",\r\n \"Value\": \"1234567890123\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"cityCode\",\r\n \"Value\": \"123456789\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"contactPhoneNumber\",\r\n \"Value\": \"1234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"developerId\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeEcommerce\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeMoto\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeRestaurant\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantCategoryCodeRetail\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberEcommerce\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberMoto\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberRestaurant\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantNumberRetail\",\r\n \"Value\": \"123456789012\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"name\",\r\n \"Value\": \"1234567890123456789012345\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"state\",\r\n \"Value\": \"FL\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"storeNumber\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberEcommerce\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberMoto\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberRestaurant\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalIdNumberRetail\",\r\n \"Value\": \"12345678\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"terminalNumber\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"timeZone\",\r\n \"Value\": \"706\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"versionId\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"merchantLocationNumber\",\r\n \"Value\": \"12345\",\r\n \"DataType\": \"String\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 09 Mar 2021 17:41:13 GMT"},{"key":"Content-Length","value":"185"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": null,\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": \"cards-realtime/heartland-exchange\",\n \"ReturnObjectType\": null,\n \"PageSize\": 0,\n \"Page\": 0,\n \"Total\": 0\n}"}],"_postman_id":"d603e4f9-9580-4141-9fb3-38acb9842e55"},{"name":"cards-realtime/heartland-portico","id":"425b545e-76d5-412a-8907-dc390512a071","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"IsActive\": true,\r\n \"Type\": \"cards-realtime/heartland-portico\",\r\n \"DataElements\": [\r\n {\r\n \"Name\": \"accountProcessingPolicy\",\r\n \"Value\": \"VMXDN---\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"licenseId\",\r\n \"Value\": \"1234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"developerId\",\r\n \"Value\": \"123456\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"password\",\r\n \"Value\": \"123456789012345678901234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"deviceId\",\r\n \"Value\": \"1234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"siteId\",\r\n \"Value\": \"1234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"username\",\r\n \"Value\": \"12345678901234567890\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"version\",\r\n \"Value\": \"1234\",\r\n \"DataType\": \"String\"\r\n },\r\n {\r\n \"Name\": \"isInfoRequestSupported\",\r\n \"Value\": \"false\",\r\n \"DataType\": \"Boolean\"\r\n },\r\n {\r\n \"Name\": \"isTransferSupported\",\r\n \"Value\": \"false\",\r\n \"DataType\": \"Boolean\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/Boarding/CreateProfile","description":"

Property Name	Required	Min	Max	Reg Ex	Default
accountProcessingPolicy	YES	8	8	N/A	VMXD----
licenseId	YES	N/A	10	N/A	1234567890
developerId	YES	N/A	6	N/A	123456
password	YES	N/A	30	N/A	password
deviceId	YES	N/A	10	N/A	1234567890
siteId	YES	N/A	10	N/A	1234567890
username	YES	N/A	20	N/A	username
version	YES	N/A	4	N/A	1234
isInfoRequestSupported	NO	N/A	N/A	N/A	false
isTransferSupported	NO	N/A	N/A	N/A	false

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

Property Name	Required	Min	Max	Reg Ex	Default
accountProcessingPolicy	YES	8	8	N/A	VMXD---B
atmMerchantType	NO	N/A	N/A	N/A	false
cashOnlyAtmMerchantType	NO	N/A	N/A	N/A	false
acquiringInstitutionIdCode	YES	N/A	11	N/A	null
forwardingInstitutionIdCode	YES	N/A	11	N/A	10999931565
merchantId	YES	N/A	15	N/A	null
terminalId	YES	N/A	8	N/A	null
itemDescription	NO	N/A	9	N/A	null
merchantCategoryCode	YES	N/A	4	N/A	null
merchantCity	YES	N/A	21	N/A	840
merchantCountyCode	YES	N/A	3	N/A	null
merchantFnsNumber	NO	N/A	7	N/A	null
merchantName	YES	N/A	50	N/A	null
merchantPostalCode	YES	N/A	15	N/A	null
merchantState	YES	N/A	2	N/A	null
merchantStreet	YES	N/A	38	N/A	null

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default
ClientID	YES	N/A	15	N/A	NULL
LocationID	YES	N/A	15	N/A	NULL
TerminalID	YES	N/A	15	N/A	NULL
IntegrationID	YES	N/A	15	N/A	NULL
IntegrationPWD	YES	N/A	20	N/A	NULL
InitiatorType	YES	1	1	N/A	E
InitiatorID	YES	N/A	15	N/A	NULL
InitiatorPWD	NO	N/A	15	N/A	NULL
IndustryID	YES	1	1	N/A	R

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default	Notes
FtpUser	YES	N/A	20	N/A	NULL
FtpPassword	YES	N/A	20	N/A	NULL
StoreNumber	YES	N/A	10	N/A	NULL
MerchantNumber	YES	N/A	10	N/A	NULL
Division	YES	N/A	20	N/A	NULL
RoutingNumber	YES	N/A	19	N/A	NULL
Currency	YES	3	3	N/A	USD	Use USD
IndustryID	YES	1	1	N/A	R	D,R,E,F
SenderID	NO	N/A	20	N/A	NULL

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default	Notes
FtpUser	YES	N/A	20	N/A	NULL
FtpPassword	YES	N/A	20	N/A	NULL
StoreNumber	YES	N/A	10	N/A	NULL
MerchantNumber	YES	N/A	10	N/A	NULL
Division	YES	N/A	20	N/A	NULL
RoutingNumber	YES	N/A	19	N/A	NULL
Currency	YES	3	3	N/A	USD	Use USD
IndustryID	YES	1	1	N/A	R	D,R,E,F
SenderID	NO	N/A	20	N/A	NULL

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Required	Min	Max	Reg Ex	Default	Notes
TBD	YES	N/A	20	N/A	NULL

Return ResponseModel with Success as true or false. If successful, the newly created object ID will be returned.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","Boarding","CreateProfile"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8587ee76-f963-4763-90be-27e689ddaf05"}],"id":"eaea0ca7-7ed2-4296-8b3e-867e9c477c4f","description":"

This section has specific information about the DataElements within the various Processor Profiles.

The AccountProcessingPolicy is a BIT table. It is represented by a string of 8 characters. Each character determines whether a card type is turned on or off for processing. Each position is assigned to a specific type of card, arranged in the next position:

VMXDNGFB where

1 – V – Visa
2 – M – MasterCard
3 – X – Amex
4 – D – Discover Card
5 – N – Diner’s Card
6 – G – Gift Card
7 – F – Fleet Card
8 – B – Bank Card

The above shown values are possible only in the described order. If the letter is specified, the processing is allowed. To block the definite type of card, you need to install the hyphen mark (-) instead of the letter, as it is shown in the example below.

Examples:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Provided Value	Description
VMXDNGFB	all types of cards are allowed for processing.
VMXDN---	allows only Visa, MasterCard, Amex, Discover, Dinners card types processing.
VM-DNGFB	allows processing for all types of cards, except for Amex.

CreditPolicyClassifier

Each processor contains a CreditPolicyClassifier element which indicates what types of Credit/Refund the processor supports. Note that Credit refers to a blind-refund and Refund refers to a void or refund using a referenced transaction.

To see the CreditPolicyClassifier in the response for the following requests, you must include the data element \"IncludeGraph\" = true:

GetOrganization
GetOrganizations
GetOrganizationsForUser
GetProfile
GetProfiles

The following table outlines the possible values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Returned Value	Description
CR	Indicates both Credits and Refunds are supported
RO	Indicates only Refunds are supported
CO	Indicates only Credits are supported
NS	Indicates that neither Credits nor Refunds are supported or turned off. Generally, BridgePay may enable Void and Refund by reference number.

","_postman_id":"eaea0ca7-7ed2-4296-8b3e-867e9c477c4f"},{"name":"A.3 Version Reporting","item":[{"name":"BoardingAPI Version Reporting","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","id":"100ced91-8edd-402a-9b12-f73b44423ad8"}}],"id":"ceaabdbd-446f-4524-b0a4-e5024b5be7d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.bridgepaynetsecuretest.com/Boarding.API/api/VersionReporter/GetVersion","urlObject":{"path":["Boarding.API","api","VersionReporter","GetVersion"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0318c449-e8e9-42c0-9828-289b2d7e493d","name":"Boarding API","originalRequest":{"method":"GET","header":[],"url":"www.bridgepaynetsecuretest.com/Boarding.API/api/VersionReporter/GetVersion"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ApplicationName\": \"Bridgepay.Boarding.API\",\n \"VersionNumber\": \"2022.2.0.131\"\n}"}],"_postman_id":"ceaabdbd-446f-4524-b0a4-e5024b5be7d7"}],"id":"22433d65-c4f7-43c0-a8f5-bacaa589f69b","description":"

To get the current version of the Boarding API, use the following request.

\n","_postman_id":"22433d65-c4f7-43c0-a8f5-bacaa589f69b"},{"name":"A.4 Legacy Integrations","item":[{"name":"TokenPay Authentication","item":[{"name":"CreateTokenPayAuthentication","id":"a05f8801-8763-4ee6-9b33-bf89ada8d0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": \"ExampleMerchantAccountId\",\r\n \"PrivateKey\": \"YourPrivateKeyForUseWithReturnedPublicKey\",\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2020-12-25T00:00:00\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/CreateTokenPayAuthentication","description":"

Using this call, you can create a Token Pay Authentication Token.

The response will include the Public Key which works with your defined Private key. The private key MUST be secured and never shared. The Private key will never be returned in any TokenPay call.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","TokenPay","CreateTokenPayAuthentication"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9ad62464-5fbb-4a3e-b81b-e2c719b03d36","name":"Created Token Pay Authentication Key Pair","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": \"ExampleMerchantAccountId\",\r\n \"PrivateKey\": \"YourPrivateKeyForUseWithReturnedPublicKey\",\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2020-12-25T00:00:00\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/CreateTokenPayAuthentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Dec 2020 16:59:24 GMT"},{"key":"Content-Length","value":"358"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2020-12-25T00:00:00\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"TokenPayAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"a05f8801-8763-4ee6-9b33-bf89ada8d0ec"},{"name":"UpdateTokenPayAuthentication","id":"d5bf251e-fd94-45fe-af6e-ca7eef0a7657","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": \"ExampleMerchantAccountId\",\r\n \"PublicKey\": \"ThePublicKey\",\r\n \"PrivateKey\": null,\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2020-12-31T23:59:59\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/UpdateTokenPayAuthentication","description":"

Using this call, you can edit an existing Token Pay Authentication.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","TokenPay","UpdateTokenPayAuthentication"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"4b853032-8dcd-4a4a-933d-1ae298250e7d","name":"Updating a TokenPay Authentication","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": \"ExampleMerchantAccountId\",\r\n \"PublicKey\": \"ThePublicKey\",\r\n \"PrivateKey\": null,\r\n \"NeverExpires\": false,\r\n \"ExpirationDate\": \"2020-12-31T23:59:59\",\r\n \"IsActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/UpdateTokenPayAuthentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Dec 2020 17:48:10 GMT"},{"key":"Content-Length","value":"358"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2020-12-31T23:59:59\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"TokenPayAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"d5bf251e-fd94-45fe-af6e-ca7eef0a7657"},{"name":"GetTokenPayAuthentications","id":"860385eb-2b9c-4de1-94d0-dcacd372e589","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/GetTokenPayAuthentications","description":"

Using this call, you can get a list of all existing authentication tokens for a given merchant account organization Id.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","TokenPay","GetTokenPayAuthentications"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"e75c15cb-0907-4853-81b0-9c8b8900c269","name":"Getting the list of token pay authentication tokens","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/GetTokenPayAuthentications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Dec 2020 17:50:12 GMT"},{"key":"Content-Length","value":"1239"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": [\n {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey1\",\n \"PrivateKey\": null,\n \"NeverExpires\": true,\n \"ExpirationDate\": null,\n \"IsActive\": true\n },\n {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey2\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2020-12-25T00:00:00\",\n \"IsActive\": true\n },\n {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey3\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2020-12-31T23:59:59\",\n \"IsActive\": true\n }\n ],\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"List\",\n \"PageSize\": 3,\n \"Page\": 1,\n \"Total\": 3\n}"}],"_postman_id":"860385eb-2b9c-4de1-94d0-dcacd372e589"},{"name":"GetTokenPayAuthentication","id":"ee5e0bc3-fabc-498d-8c86-52e7b6021fba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"PublicKey\": \"ThePublicKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/GetTokenPayAuthentication","description":"

Using this call, you can get the given configuration for a Public Key.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","TokenPay","GetTokenPayAuthentication"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"7d98e99d-9e72-4448-8397-8de5cac86537","name":"Get current settings for a given Public Key","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"OrganizationId\": ExampleMerchantAccountId,\r\n \"PublicKey\": \"ThePublicKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/GetTokenPayAuthentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Dec 2020 17:57:04 GMT"},{"key":"Content-Length","value":"358"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2020-12-31T23:59:59\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"TokenPayAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"ee5e0bc3-fabc-498d-8c86-52e7b6021fba"},{"name":"ActivateTokenPayAuthentication","id":"7eaba580-6c29-43bf-99e7-3bd852ec95d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"PublicKey\": \"ThePublicKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/ActivateTokenPayAuthentication","description":"

Using this call, you can activate a Key.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","TokenPay","ActivateTokenPayAuthentication"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"8ab22af3-8c8c-4baf-b32a-f95bcde5d246","name":"Activate a Key","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"PublicKey\": \"ThePublicKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/ActivateTokenPayAuthentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Dec 2020 17:59:08 GMT"},{"key":"Content-Length","value":"358"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2020-12-31T23:59:59\",\n \"IsActive\": true\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"TokenPayAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"7eaba580-6c29-43bf-99e7-3bd852ec95d0"},{"name":"DeactivateTokenPayAuthentication","id":"51be3c5e-3674-424b-ac05-66fe6541e370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"PublicKey\": \"ThePublicKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/DeactivateTokenPayAuthentication","description":"

Using this call, you can get an authentication token for use with token pay.

\n","urlObject":{"protocol":"https","path":["Boarding.API","api","TokenPay","DeactivateTokenPayAuthentication"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"8b3404a5-17e7-44ff-bc95-0d6cfbf1a600","name":"DeactivateTokenPayAuthentication","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"valid user name\",\r\n \"Password\": \"valid password\"\r\n },\r\n \"PublicKey\": \"ThePublicKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Boarding.API/api/TokenPay/DeactivateTokenPayAuthentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Dec 2020 18:01:02 GMT"},{"key":"Content-Length","value":"359"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnObject\": {\n \"Credentials\": null,\n \"OrganizationId\": ExampleMerchantAccountId,\n \"PublicKey\": \"ThePublicKey\",\n \"PrivateKey\": null,\n \"NeverExpires\": false,\n \"ExpirationDate\": \"2020-12-31T23:59:59\",\n \"IsActive\": false\n },\n \"MissingFields\": [],\n \"InvalidFields\": [],\n \"Messages\": [],\n \"Success\": true,\n \"Id\": null,\n \"ReturnObjectType\": \"TokenPayAuthenticationModel\",\n \"PageSize\": 1,\n \"Page\": 1,\n \"Total\": 1\n}"}],"_postman_id":"51be3c5e-3674-424b-ac05-66fe6541e370"}],"id":"16c845a8-dfcd-43b0-82b3-1d1f0c0581f7","description":"

This section gives examples of working with TokenPay via the boarding API, for usage of token pay please reference the BridgePay Dev Center for Card Not Present>TokenPay.js

\n","_postman_id":"16c845a8-dfcd-43b0-82b3-1d1f0c0581f7"}],"id":"cec45633-1690-4331-9352-7497ff6956f1","description":"

This section contains legacy portions of the Boarding API that have been supplanted by newer functionality. The following are not to be used by new integrations. They are only preserved for existing integrations which have not transitioned to new functionality.

\n","_postman_id":"cec45633-1690-4331-9352-7497ff6956f1"}],"id":"2e9a3607-5cfe-48af-84e2-0b4cd1206a64","description":"

Document Version:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Version:	Updated by:	Change(s):	Date:
1.4	Noah Hippensteel	Updated documentation for FE 25.7	07/22/2026
1.3	Noah Hippensteel	Updated time zone codes	05/15/2026
1.2	Noah Hippensteel	Updated data elements available in UpdateUser request type for clarity.	10/02/2025
1.1	Mark Mauer	Updated the www.bridgepaynetsecuretest.com in the API Authentication section as they were not valid.	02/19/2025
1.0	Noah Hippensteel	Added Document Version Table.	09/09/2024

","_postman_id":"2e9a3607-5cfe-48af-84e2-0b4cd1206a64"}],"event":[{"listen":"prerequest","script":{"id":"b730643c-3a8e-4a14-b750-6fd4e27a4a4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ad949630-73e9-4283-9271-9ad41850e28f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BaseURL","value":"www.bridgepaynetsecuretest.com"},{"key":"UserName","value":"valid user name"},{"key":"Password","value":"valid password"},{"key":"NameMod","value":"01"},{"key":"ResellerId","value":"OrgId for Reseller"},{"key":"MerchantGroupRole","value":"Use GetRoles"},{"key":"PasswordForUser","value":"Desired User Password"},{"key":"MerchantGroupId","value":"ExampleMerchantGroupId"},{"key":"MerchantAccountId","value":"ExampleMerchantAccountId"},{"key":"MerchantAccountRole","value":"Use GetRoles"},{"key":"CurrentOrgId","value":"Example OrgId"},{"key":"SalesAgentId","value":"OrgId for SalesAgent"},{"key":"SalesAgentAccountRole","value":"Use GetRoles"},{"key":"TokenPayPublicKey","value":"ThePublicKey"},{"key":"TokenPayPrivateKey","value":"YourPrivateKeyForUseWithReturnedPublicKey"},{"key":"ParentOrgId","value":"Example ParentId"},{"key":"UserLastName","value":"Last Name to Search"},{"key":"UsersId","value":"ID of User"},{"key":"ReturnedUserName","value":"The User Name"},{"key":"ServiceConfigurationId","value":"","type":"string"},{"key":"ServiceApplicationId","value":"","type":"string"}]}