{"info":{"_postman_id":"ffe19b4a-3035-4377-9e80-829a0c6fe724","name":"Hosted Payment Page Development Guide","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"24254550","collectionId":"ffe19b4a-3035-4377-9e80-829a0c6fe724","publishedId":"2sA3s6GW6N","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"336699"},"publishDate":"2024-08-14T20:22:00.000Z"},"item":[{"name":"Specific Request Layouts","item":[{"name":"API Authentication","item":[{"name":"CreateApiAuthentication","id":"dabe0d8d-57f2-40ff-a56e-6b02c2c7e6aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"ApplicationType\": \"2\",\r\n \"OrganizationId\": \"#####\",\r\n \"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","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ApiAuthentication","Create"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"041bfdc9-d123-41d6-bc90-e2bdff92400a","name":"CreateApiAuthentication","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 \"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":"dabe0d8d-57f2-40ff-a56e-6b02c2c7e6aa"},{"name":"UpdateApiAuthentication","id":"3657b0ed-c2e0-47b8-8679-34be43b299f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"ApplicationType\": \"2\",\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","description":"

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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ApiAuthentication","Update"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"26f17a51-d8f1-4033-b335-690ca434ba76","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":"3657b0ed-c2e0-47b8-8679-34be43b299f7"},{"name":"GetApiAuthentication By Filter","id":"3987fa31-2d78-4a30-8065-81f325746227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Credentials\": {\r\n \"UserName\": \"#####\",\r\n \"Password\": \"#####\"\r\n },\r\n \"ApplicationType\": \"2\",\r\n \"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","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ApiAuthentication","GetByFilter"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0d40a810-6a75-4fbb-bdc6-3f49f966e225","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":"3987fa31-2d78-4a30-8065-81f325746227"},{"name":"GetApiAuthentication","id":"dd2f67d0-2dfe-4495-a7db-302eb6f47d8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"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","description":"

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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ApiAuthentication","Get"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"b395a484-56f5-4ac7-945d-2a5960070b81","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":"dd2f67d0-2dfe-4495-a7db-302eb6f47d8a"},{"name":"ActivateApiAuthentication","id":"1fc8224b-bf86-4bed-b802-036446a521b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"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","description":"

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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ApiAuthentication","Activate"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"4dad4a4f-e73c-4af3-b681-932cfa3416f5","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":"1fc8224b-bf86-4bed-b802-036446a521b8"},{"name":"DeactivateApiAuthentication","id":"7a685561-6d11-4b7b-bbcf-8b03f771efc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"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","description":"

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

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ApiAuthentication","Deactivate"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"3abdcf1e-e828-41ac-b649-6a54e9bb6fa2","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":"7a685561-6d11-4b7b-bbcf-8b03f771efc2"}],"id":"59d9de92-243c-441e-8880-5b40a680df61","description":"

The following requests are used to create your publicKey which is used to obtain an AuthToken using the BridgePay AuthToken request.

\n","_postman_id":"59d9de92-243c-441e-8880-5b40a680df61","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}}},{"name":"Create/Update Hosted Payment Page","item":[{"name":"Create Payment Page","id":"6a9d8e26-076d-4f6a-ac6d-687e592712f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"pageName\": \"Test Page Name\",\r\n \"organizationId\": #####,\r\n \"iframeSupport\": true,\r\n \"iframeDomainUrl\": \"https://www.yoursite.asdf\",\r\n \"status\": true,\r\n \"companyName\": \"Test Company Name\",\r\n \"category\": \"Test Category\",\r\n \"amountBehaviorId\": 1,\r\n \"paymentTypes\": \"VMAXD\",\r\n \"termsAndConditionsUrl\": \"https://www.yoursite.asdf\",\r\n \"privacyPolicyUrl\": \"https://www.yoursite.asdf\",\r\n \"successfulPaymentUrl\": \"https://www.google.com\",\r\n \"failedPaymentUrl\": \"https://www.yahoo.com\",\r\n \"primaryColor\": \"#48BAC9\",\r\n \"pageBackgroundColor\": \"#F5F9FA\",\r\n \"sectionBackgroundColor\": \"#FFFFFF\",\r\n \"headerTextColor\": \"#48BAC9\",\r\n \"paymentDetailsTextColor\": \"#48BAC9\",\r\n \"textColor\": \"#527C81\",\r\n \"displayDivider\": true,\r\n \"c2pEnabled\": true,\r\n \"c2pDpaUri\": \"https://www.yoursite.asdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage","description":"

The Create Payment Page request is used to create a new payment page configuration.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["Hosted.Payment.Page.API","api","PaymentPage"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"c7bd93cd-a415-4796-8110-a23ac9ec217d","name":"Create Payment Page","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"pageName\": \"Test Page Name\",\r\n \"organizationId\": #####,\r\n \"status\": true,\r\n \"companyName\": \"Test Company Name\",\r\n \"category\": \"Test Category\",\r\n \"amountBehaviorId\": 1,\r\n \"amount\": 99999999,\r\n \"paymentTypes\": \"VMAXD\",\r\n \"termsAndConditionsUrl\": \"https://www.yoursite.asdf\",\r\n \"privacyPolicyUrl\": \"https://www.yoursite.asdf\",\r\n \"successfulPaymentUrl\": \"https://www.google.com\",\r\n \"failedPaymentUrl\": \"https://www.yahoo.com\",\r\n \"primaryColor\": \"#48BAC9\",\r\n \"pageBackgroundColor\": \"#F5F9FA\",\r\n \"sectionBackgroundColor\": \"#FFFFFF\",\r\n \"headerTextColor\": \"#48BAC9\",\r\n \"paymentDetailsTextColor\": \"#48BAC9\",\r\n \"textColor\": \"#527C81\",\r\n \"displayDivider\": true,\r\n \"c2pEnabled\": true,\r\n \"c2pDpaUri\": \"https://www.yoursite.asdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 32,\n \"pageName\": \"Test Page Name\",\n \"organizationId\": 10501,\n \"status\": true,\n \"createDateUtc\": \"2024-05-07T17:14:04.79\",\n \"modifiedDateUtc\": \"2024-05-07T17:13:59.1839882Z\",\n \"insertDate\": \"2024-05-07T13:14:04.793\",\n \"companyName\": \"Test Company Name\",\n \"category\": \"Test Category\",\n \"amountBehaviorId\": 1,\n \"amount\": 99999999,\n \"paymentTypes\": \"VMAXD\",\n \"termsAndConditionsUrl\": \"https://www.yoursite.asdf\",\n \"privacyPolicyUrl\": \"https://www.yoursite.asdf\",\n \"successfulPaymentUrl\": \"https://www.yoursite.asdf\",\n \"failedPaymentUrl\": \"https://www.yoursite.asdf\",\n \"primaryColor\": \"#48BAC9\",\n \"pageBackgroundColor\": \"#F5F9FA\",\n \"sectionBackgroundColor\": \"#FFFFFF\",\n \"headerTextColor\": \"#48BAC9\",\n \"paymentDetailsTextColor\": \"#48BAC9\",\n \"textColor\": \"#527C81\",\n \"displayDivider\": true,\n \"c2pEnabled\": true,\n \"c2pDpaId\": \"88566886-d2c0-4a7f-be7a-4cda93e55958\",\n \"c2pDpaUri\": \"https://www.yoursite.asdf\"\n}"}],"_postman_id":"6a9d8e26-076d-4f6a-ac6d-687e592712f9"},{"name":"Update Payment Page","id":"4d5fab9b-e63a-48db-99e2-efd8479bcaba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"pageName\": \"Test Page Name\",\r\n \"organizationId\": #####,\r\n \"iframeSupport\": true,\r\n \"iframeDomainUrl\": \"https://www.yoursite.asdf\",\r\n \"status\": true,\r\n \"companyName\": \"Test Company Name\",\r\n \"category\": \"Test Category\",\r\n \"amountBehaviorId\": 1,\r\n \"amount\": 99999999,\r\n \"paymentTypes\": \"VMAXD\",\r\n \"termsAndConditionsUrl\": \"https://www.yoursite.asdf\",\r\n \"privacyPolicyUrl\": \"https://www.yoursite.asdf\",\r\n \"successfulPaymentUrl\": \"https://www.yoursite.asdf\",\r\n \"failedPaymentUrl\": \"https://www.yoursite.asdf\",\r\n \"primaryColor\": \"#48BAC9\",\r\n \"pageBackgroundColor\": \"#F5F9FA\",\r\n \"sectionBackgroundColor\": \"#FFFFFF\",\r\n \"headerTextColor\": \"#48BAC9\",\r\n \"paymentDetailsTextColor\": \"#48BAC9\",\r\n \"textColor\": \"#527C81\",\r\n \"displayDivider\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####","description":"

The Update Payment Page request is used to update an existing payment page configuration.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["Hosted.Payment.Page.API","api","PaymentPage","#####"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"7d3cf58b-bf3d-4bc2-9040-c5148d583549","name":"Update Payment Page","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"pageName\": \"Test Page Name\",\r\n \"organizationId\": #####,\r\n \"status\": true,\r\n \"companyName\": \"Test Company Name\",\r\n \"category\": \"Test Category\",\r\n \"amountBehaviorId\": 1,\r\n \"amount\": 99999999,\r\n \"paymentTypes\": \"VMAXD\",\r\n \"termsAndConditionsUrl\": \"https://www.yoursite.asdf\",\r\n \"privacyPolicyUrl\": \"https://www.yoursite.asdf\",\r\n \"successfulPaymentUrl\": \"https://www.yoursite.asdf\",\r\n \"failedPaymentUrl\": \"https://www.yoursite.asdf\",\r\n \"primaryColor\": \"#48BAC9\",\r\n \"pageBackgroundColor\": \"#F5F9FA\",\r\n \"sectionBackgroundColor\": \"#FFFFFF\",\r\n \"headerTextColor\": \"#48BAC9\",\r\n \"paymentDetailsTextColor\": \"#48BAC9\",\r\n \"textColor\": \"#527C81\",\r\n \"displayDivider\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"pageName\": \"Test Page Name\",\n \"organizationId\": 22448,\n \"status\": true,\n \"createDateUtc\": \"2024-06-05T14:16:19.163\",\n \"modifiedDateUtc\": \"2024-06-05T17:49:51.8320244Z\",\n \"insertDate\": \"2024-06-05T10:16:19.163\",\n \"companyName\": \"Test Company Name\",\n \"category\": \"Test Category\",\n \"amountBehaviorId\": 1,\n \"amount\": 99999999,\n \"paymentTypes\": \"VMAXD\",\n \"termsAndConditionsUrl\": \"https://www.yoursite.asdf\",\n \"privacyPolicyUrl\": \"https://www.yoursite.asdf\",\n \"successfulPaymentUrl\": \"https://www.yoursite.asdf\",\n \"failedPaymentUrl\": \"https://www.yoursite.asdf\",\n \"primaryColor\": \"#48BAC9\",\n \"pageBackgroundColor\": \"#F5F9FA\",\n \"sectionBackgroundColor\": \"#FFFFFF\",\n \"headerTextColor\": \"#48BAC9\",\n \"paymentDetailsTextColor\": \"#48BAC9\",\n \"textColor\": \"#527C81\",\n \"displayDivider\": true,\n \"c2pEnabled\": false,\n \"c2pDpaId\": \"48a86b7a-bba6-4c83-9d14-d681ef4f01fd\",\n \"c2pDpaUri\": \"https://www.mysite.com\"\n}"}],"_postman_id":"4d5fab9b-e63a-48db-99e2-efd8479bcaba"},{"name":"Add Logo Image","id":"838f19c6-cd3b-4a56-898a-a10cfcad48a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"ImageFile","description":"

The logo image for your Hosted Payment Page.

\n","type":"file","value":null}]},"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####/Image/logo","description":"

The Add Logo Image is used to apply a Logo Image to an existing payment page.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["Hosted.Payment.Page.API","api","PaymentPage","#####","Image","logo"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"7a7fa692-5f61-4e75-9a0a-3eed62983dad","name":"Add Logo Image","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"ImageFile","description":"The logo image for your Hosted Payment Page.","type":"file","value":null}]},"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####/Image/logo"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"hostedPaymentPageId\": 2,\n \"insertDate\": \"2024-06-06T16:52:20.097\",\n \"contentType\": \"png\",\n \"imageType\": \"logo\",\n \"image\": \"iVBORw0KGgoAAAANSUhEUgAAAMkAAAA4CAYAAABXCNy5AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAD2AAAA9gAXp4RY0AAB4aSURBVHhe7Z0HuFXFtcfnFkBBYi8Re++F2BVRMViePZYYS2wRGy+aZ+zGEhNLsCb2khh7wxo1saKCEQ1WLChKxIKKCkqRdu/7/+bstZkzZ+9zzi3ovR/n/33rzt6zZ8+eM7PWzJo1a+bWuVZgxeMeWkzBVqItReuLVhYtKjI0iT4SvSN6UfS06NnRF+/0ncIaauhUaJGQSDj6KjhKtIOoJ3EtAEJzl+hyCctoIpRfna6bua6hho6KXCEJGVjXjBZ/EvXjvo1glLladLry/9LH1FBDB0Z9EhYhEpA/Khghag8BAXzzSNFo5b2PjxH4ZnJZQw0dCiWMaQKicAHdPijawj9wDqFpL0YO87pM3/s1F/ZtH1tDDR0ERUwfCAgT8+dFK/gHcx736rt7cFETlBo6GlIhCQSEEeQ/IgSkPUePSrhT30/Vrxpq6ChI5yRB7/0P0fctIGBvCSjznxpq6FAomriLSc9VsFnh7nsVEMPJKgPmZT+y+ZgaaviBkQqJmHIDBScV7n4Q2Eh2lcrS9YeelwwYMOB7E9Lv81utwdzeYaU/XhXxuALMvN+3mpUF1lDOoXGyhEVMdZmC1UTxCj7lniB6VzTk6quvHkJka6Hv/EzB0aJJonlFI5TniQpbBeXXVcFfRMuIpou6i85Uns8p7NBQW/xYAWWfRzSLuADU+2TRhyLms0+r3T5T6AXsh+7w2govDPohuJg8xXUHAYuMK6pyJxZuiyFmG6Ng2cJdWbwhOkVMiCm7xdB3zlRwRuHO43XltU5y3WIoPwRtrGhhH1HAgcrzpuS6w0I8sqqCtwt3FYHA/E10ktpwUmcXFFO3cDXpSICJylm6vknCSlhL9ICY84TCbYsxLQkNNH5bAKPEgs+I0hnA6FFtWXuIGIFfZgRCQBAU/6QTol6FxzFxu8Jth8IBSVgJ5Xooe3a+BGXb5LoliBu20zb0HECleodWEj1CRGcfSbYR/cjfdSxsIAFeOrkuBxgXdWpP0UGi00SoWYBn1jitGU3+KtpEhFFjY9EvRTUUQN1eIGLEp95/KzK1NuxM1lU7HpZcd0rU6Qf8WeExzWKlJv2Bo5qaFOqiTj+1nj+EJNY1t98jdlMPdH9ynUKjwmsK1i7ceZwqvb5ojUVpnlBAB2D4QrSK0k3QszqFmT2bni2uAFecT5QGr4MilHsX6DneCqh55INhAY9n5jLNetao61Gi5UWGn+vZHcl1CfTOUgr4rQuKpopGKf1IhVUjLLOuMR6sIWItjEk487+39JxJt0eY3iA+YVTgu7xv2FDt81Jy7aF0uyq4r3CX4gGlI95DadI5iq4bFKwrok7Im3Z6Xc/9xD8L4fsxsp5VSF+vZzjd5qJu/sPuGdJQX7dlt8YGN2/XBtelsc716Nbo5unS4GbManKTvpvpZklops1oclNnzHLTZza5xvo617Wx3pPeTbKaIzhLP4DJcxHUiLGQnKNGPZ0La2CFu+n2XuISYKFaS8/+y42e76WAUedrEW7/WG7mE9E7wjxXihBQ1o6YA2GJGq73j1HoETKTrs2Evr0InTwE1rZLRVeJGOWwzBlSIYny66PgVBFGlW7EBSCPy5T2WqVj+8LFom9F/I5/KN7XRQilm18Blrn9RfEIzVyDfT+D9K5n8LAsQMyUJST91D5PJtcplPYGBQcX7jzeFK0NMxrDKqTDYPRhlIndn5j7PSw6Q2nfUtrrdI3BZIYI6+V+In4jv512pUyfi/ZXeu5LoDwwmtwqovPi99LWw5W+4ny8/pj+K69xwb7rupuP3tg9dHwfN+S0bdyTp2zt/nVSX/f4yVu5Z07fxoeDj9vc3ThgI3fePuu4/TZf1q251PyusaHOTZwyw00QITxzAGGPWxWChqVSQsBE4wuXHjQMFU9F9xZdKMK0jIAAGmMVEdsESLOhCMb1iBj6bAUwGSbjWEAAm9IQQjafwawliPI7T8EzIuaKsYAARqprlI5GZ9SjjLYBbiNREZSuv4L3RCeLslRYmGxz0b1Ke5+oO2VR2NoeEK/xENQpQuHnJmLYFXWJoDP6xwICqEM6sTeV9lCFm4qofxa6dxTNFGEl/ImItuE5IxXXeaAu6ThJSzre9fuaKqH+nL3WXuTQrVZo3maNxd3qvX7kFp9/Hjd/9y5+NPnRvF3cIj27uaUX7u56L7eg237dH7sB/VZ0lxywvheif5+1rbvuVxu6X2y2jH8PgYFmauRpJ+BHVg1QQ1KocRdRYAujVpin1PChdSq0XJEGdSYEI0e8DpP2UgFDX6LAeu5KPxyGZr2hJF2QH4JqazGV8ttXhIk6TFdkgVN+CO4/RdRJufzsGcz2gt7r0QZBYR0oxDcSDm8ZE9PT8b0gwqTMNyv9RkYRhMpAZ0fbEM91iF8kYRZiQxAjDyN7RZgJuKQivpWaNWzUeHf1k6PdyXe85g6//kV3yDXD3aGi4295xV31xHvug88nu11/0stddmBvN+zMfu6GwzdyO/de0nWRCvblpOleRWsjKlWgYUc15mmiP4pu1j16P6MEBeC3UZn0onkgTfgt9GJ6wy7+Lgf61kAF3s1f4H2rR+ZDqIkYC5j8MyqFyGQ85TdAAXmCML9/i+h1jxehBn4sMlDGvPyog7sLd2ldANQ/mIzRk8k2DMwzvgkxUrGLNByZs1DUOYFECOj9Q7yfhIDvYeK3fPnuFBGjIh0bHQ6qVoh4NO2WqFV3Fm5TbKfvl4zUiuulwLs7CfbdG5RHVSZ9PwTaJB0MH/2lu3XYh26oBOSjr6Z4Rq8X04etwFeY5HdpqHfLaJT52YZLuSO3XckLCPTBF5PdXS+MdXcPH+veGzfJzaO5TndRKxB+Ng8UB1UBCkE8nQDDch819odimnqFeZLLt5jEYqlBr6cXzXXT0TMm1IMKd/5bvA/T7KV3cRJNobTo3iwYWkOVQGnQleP8CPdXfjBQCqU9VsEVopgZY7ADFFhdgJOU3/nJtYfyW07B7SIseKQFOyj+YKVFyPOwhhjwE4Xo94zEjJT/J1pIZL8BeDOw0jLHWpPrBDxHrdxXDEs+KZSWOd5gEephmBewawQ9rAOE739ERfUlYPk09Zt3Udeu8XdVoF5fn4aAMEE/9qaX3S4XPuduem6MGzfxOzF2o1tovq5uAalfqGBG3C/Uo6ubTyrZpxOmuvMffMttftYTEi4/J3bLL9rDnbDTau6pU7d2g/Zbz626RE/31eTpbur02JuhIkp6qgyElRfC4tG3t+ZCDd6khs9LDw5QmodExijlwASevMMG3EnvFgkIUNyXInTpYYWYTNDYMBuw/PbWe7GAMHeZLmLC63t7oaS8Ssc8BPM1sPxO1HtFAgIUhwcDDM4Em7SW32+SMA/Xij4QvS56VoSRI1brYIrrxfT0kkf4mAL4zmsSjr6xgADFYTVj7sCIYeUvgtIwwqK6hWAuE4OJfoi79S7lrgrYpsaMGvet2/78Ie5vz3zgundrcAtKALo11qejSx54jhWMecv4b6e5swaPdJOnIaQFMK85pO/y7olTt3KX7L++n9t4NUyT/ApZGzg8ohLKMTSjBj30X8U03vVDDJGXHkZBd68WOyeh/ZTrlXeJpQcEgmmqWQgb2XZKQsP9ys9UpRSUP8jvf0WoDFnVmZpcEwzVu1juMqFnNJytA1l+a+lbGDXyQDqjEGHcfmJI6hwrHaNvCMrPqBG/7+MSRj6rEJOLeKTrr3eXSK7Jhwk6k/4QlydhVah/7PVxbxxwxQsOQVlUzO7XRVoIagBzMELB+1i6bhlaGFUAcQf2Wc49fdrW7uw913ILaiQaL2Fhgl/ha/RQlUAW9Ci/F8EEWJFw1qTRUTFMKPZXg5MmD+PEKHmqWBGUD42NihLiliQsAYydhPSO8W/CrAmwgIWIVYYUQX7jFDD/CWG/IWbuRpX7DNEg0Z8yCIsa5mHmByHyhMTqNQ84OvYWow8t3Pq1kBBv65l3QE2EqAhBHCqX1VEWGE0x4xuY1DNqG2wUsfyGKu8WOZTW73v580+NmzjVq1GVfnUlwK3IGAJz8SOj3F6XDnNTkpGFeQ+jzsD+K7snpYYN7L+ST4/5uMx3qehq8KAY5nci1ImBop8qjrUI3g/l8Hgxw5LJdYwwXSWwYEhjGJj4MhJVA84iCzFTZUKXNlXLEKfLA5PwECYk4e+kiplvYExgzoABICYsaox04e8CeV4P1BcWIn438z7MqTAfvfSOYsQNRPhuWb0yeQ5RlflV+FQUGiqKoG98peCewl3KSj/nj76NOsx8BFg56ERbhPp5uzY+xgQcJm5PLNyzq3tgxMdu14uek4o1LVXd+Azq2dl7ru0e/u2Wbrt1lnATNF+ZovlKxKVvqALMvaQS4jURelkaAZNg+Muw16N7/5DIGq346dHPL9d3FKGdW64E3riTg4PVRlizWMFfRdd9RMeIbKIernTHv6+qUVvg/Uq/kcVLYN/oq2+zsMqcJhRyBLpEha2E+o/+vAvmUhsS2xUIw0vvf+UOv26250JYU6zL3HzUJu76X23krWTjJUys7idpwtXy1gJBYREtRN5I0hJgBQvXUOix8nrcGCxQhoAJyS9eKWaFuxrEi3FWxfTyBuJYSMVTAXf3tzLI4pm8Q1wzJyzXUfkySxAmiUqYPhAQwIgQImsRMQvMKcu2mb6D+xAqt8FGEBtFrBzXKO3MYHSrCmYWvD4J2xWUrMc8je7jr6eWXWDcbYNe3hJ27Par+HSTp89qlmrW6j0WUl+sEuhNUI1CVGMxKwuNUky4YhVg7yQsgZVHIXr5elwHaFR+VE5sbakmP9S0+Dw0s7XHcx+YdD19a3WFlCMkyoTLzhqiNRPiGsHHNJyHcqNMjFeT0LCmmNVb37KYNojDQJLldRAj5mHMzSykAvJCoH2aSHgrwoQEhgwXfNoVWMowo6HSfS3VCoTqHdf4jZ2xx1rNdw7c1G29+mK3jbxgh1jXLoeilXE1ruWOnh0vLtFDtgceS0L71pFiWtxCShCUx9ZBQhhTP5qElnYf5Ze5hSHKL9PNRWDCGwJfN+YjvD8jIkzKs/S900WPi+4XPSbCP8y+1VbQ24ejG2AxM5NpiZOgMIqU+O7lADWKERmQH6v04aLl7coz/n5VYD8JeiOz698VouYMsHAxLzn8+pfcqx9O8NdWepuvCHWbrryIu+XoTc5J7qvFamrQ3qKtRP1Eh4mwcMWuKfTW7aVaspgHKD350+HAWEyQi6C47iKcGMvtaWFxK1z5BjBr5gKk4mEwFj4zIeZ+SMErhbs0P6xYLGwWQXFYvhA4fNAYmXYRUdZYBWw1xGN4PVhvb+XZTPz3gKhkq4biGPFYaAwZPRfKH68GWzeazVGzr1tk9g0RZkbBmHDhxUqhip5VAmZfTMhDz+znrVjbnT/EvT52oh9BVlxsPjfk9ILX+iZnPO4mfzfTPXpiX9droXn9KBIICTi3rq7ulOQ6E2rQ0Au4UlnD5/uKebz6oDxYtcZ71vCCntnim4fSIGQskBmGKU26sq/nFyk4rnBX9B16cRoY1Y5JLdYWesUshF7A4ffC/GgX1mBgBOYqqBF5c5b7lN/uXCg/BNZ09TA/RtN/iXC/QaVCEM3fytIxl0PtMp+rqr2A86A8MJww32GyH5aHEYA6oF1xs6GOWRTMctNA2NbSd1PXfoPyZz1keOGuCP9Uevi6VfDqljK3wrKYRENwz49od2Bqfv+LSW7fvzzvJkyZXhhRCttYwKuVBCQDVvY82POz1eDl9OsWQ/mxIo1nLwjrjNMocXzELQSzaigguW4Hyo+1CttbEuYHE3NgOSvcqJChgODGH64jpPkrP1ajbcNTmB+9NOVixMZfLBYQBGMPBESCZvXXJsBjYlTUYhY5cS618kCMFris43DI/iY6lVBAZq9Ql4HyxxM7S2hbPYoALyTK3O9BVojOxlALwkptNzByLNC9qxv58UR34JUv4APWLEGpUzT2br+KTRRhGcS2/HLAwrWnGjw80AGEPSLIcnGP06TfDZiHNRmzxFUqN+rGjYXLFH7ya/mpnDCIqSWV8sNDAPUpdMRkgTGF8iMv8jTGLAeeY+3srfdep0wKjQfglbg+snr6TAQ8hkGBERtXFL5XqUzMoyiTgfWkkneCjn72KnYBI/XNVh0EYrCJu/8RSYgPjrk08OF2FxSA79czb3/RPPDGEXWzmpq/1oc21Sgy1stMHTJTFiwSstj2cg4xH2GTE7+D3Yi22BQC6xQVSnoagTAGi2QYNCyN6fgwn3cPUThTxMjB/ABVIgswxkFKR69Ob4e9njwxTqDy+PwIQZKOvQ+kzQLvn6B0qBCx6bnEZKt0jE6s6DPvCVenQ/D7GKWwao2MBASgOqLKoBJZ2WPv5rIIBIV6xFWe0TFrMs3IQQewidKi0mIZo735bcwp4wM6LG8WLGOrIF7ToRC1GLkvKlMmcDjrVWN+q3pO0v+8IW7kRxOb5+3a4CVhxsymV3/ZZ7mdz9l7nWoFpMXIaPB2Q5y37rFwMQ9hLwyq0Bt6niWAKcqVT8/wmsXlHS9b/LRYz3hZ6VGF+Aa6efgPldbVMxg5RZi/rsmHMuJWwxyB+QB5vhakmWP1BRJB8fnrmrLj8YsKyajKCPOqnlfrwZBCeeFmj/HBgHayvPKq9nSdTJSVLn0UM9ptothBrAQtFBJv8hVuHD3kg0PdiIGz9rr0ubq7fr3FHGuYjg4xJmoTc0KYlnaBec4Vs8Z7JjyUHi2A+RC7Jak33ikyLMxNEK/SmTMaMr+y+rhQAoLLTZuQqlsxEmkfLWI7KJuHWm0OjDlf6hVD9S7K+yAEhG/NzQKSABWEUYNtuDA+C3x3SBhOFaVerbruJmL9hPShgIA/JOHcCNQsM0BQH3gA2H6aNiFXSMTAXn9MrtEdGVXYHRe7F2RDTWctl1iwwDs952k8+rMrd1tVeaaTKb6VXM610AjA4mTofGd1ggVqtATjNRFzAuZILDxiAg8FBFf9eEff3IT0gI4Eg8VXLVmQzkWukABj3mRU+VzEUj+6I3Z4nMrQZTPdPBCMpubmbxob6l/UyDFI91trvrHa4OO2YBEuFcAaZkNMztbdcEHMBAWrGkKB2mt+TKGAsJPSTL1zHcRLGGjiAzDaZPYN0WZGVQEZ4pbWnGThRXp2qx96Rj/XrUt9086Dnv308Tc+GzP973t7600N5aFRIpxc0xnhjlGNb9Qf9B5HIxXlMTdBPMgoQsfNEbIYI95Vh561wa1VqPXmHQiRoHAgOBN5FhKxROGjRXvBCJim2Wx1ndJ7L+e5WEBSS1mMcs9agpqQdAJIADDbpkIiYcC0WUMN2aDHTC494ntDXjwo9yxE1reqfTcLld7N+l5yWRZZ6VpTzrx3sspVbf5Z7yaXVaEl72c9a+n3stDmDH4I6IezRwQnuXetV00qAxPqVMX5raFJOvajs4LLc+g9PZ+kZ7zPYhy+TsRjxMAQQY/N5Hik0vmVXaVldXi87r0rtu4xybK6+6biUsOF4lnbwCzLkTp8xzsXKj5Uo1ghtxNFKBdn+xb2Dwh6zvdZHR+teL86rjjOwWIdgH8iVKQ+WN4K+S2ckPKN7r3bvT3jGiR5szOTkYnvemfAMJ2uUfPIi0XQ1A9M8fwmNkrxnl+cUxxGnG66Z4We8lFP1CV5sRA2Wc9G6RmGB/zFxurer7ArzspNvdsOQjZ58c+XcNsPy0R5+daHikvPCFa8/57iaDePJC31MEHx/mCPMK/WoKx1qwODc2ZhwPAwbX4Le6z55zEGjunBhQW3BtYVWPm2/wnJKRscQEc8xDUrv6xG8w4VTQXj08Xz8NQO3sXLN/VdUjoOUYAB8FJgf87zintJtELUQJh0+RZlwV3lE6UJj8Fh1RV3FM6PIl+2IJOO87xKGpo4pWE/PwtpuJ88onv+J0sRY+getxnKhws95eOURmjZKF/cQPi98Z57LEiUi3UcA/nYfxOj07F6tvq002fovNie6i1wVjaFCCweAzgl4tPGPOu/it8yeY7AAb6NQD+tuNBfDJ856ttDz+hMMPviyPqo7v2emuj3tRidVUis3FuoIg5MrqlQKjCsRLvGUoR7ORNh2yGHtzHOc7yHPxBbPfENMn8p2/CEiwkWEy9c+h7XuOw8ocr3C6yKg5FhGFwpeEYPh1crx9m8rOfpYqBgToIwDOdQ0QPfqTThQhj4NvkWp7BwUHfuQXkCp8Dwf2ZgOlwzcBRFaD2UD78bwUaQOIOM8mFuxmw6Qs951xDWXwgrl4WAdmjQ+zhYwuw4x8KYpGFh8xARsDx9uyUCQIeEnyCjFm2DoOMDx2g3RM83DpjbvkmacD9M3N7UAx7FnPeLe8ruyscfCtEWdFYhMeCgeJEqgi2wqC6ssma5ol+r54NFfxd9pvQNCjkozlZkUa3uEX0tYi84guJHEoEKByvrPUYVGgqm8L1UEkc+qApsgX1ShEqCYx0ewmwoCvek+AbXcxb/eM+ONbWje4wxMP+y4Mrv8gKrb4UMGoLzhcEYZclIxWjoe3i9w/dxQf9Az9YWPS2ifCxccvQOalS4yS3Pld/KFfbKVt9dlN8UEeW1TW236t7+xaCVO9wHb+sY1Blt846IkYHRAGSd04sl7yz9JhPquL2tM3pfeeH1TT20+f9RdvaRhP0c6KChU1sIa9BTVLG/SainKtAqlndB7MSJGodQ0KuhL7P1lL0QjAy289D2LTDCoJrwbwu8Lu1jBd3jjYzqsYvircfzZdI9PR5AkEDs4k1PzIFumyqfsv9TReC4T/CR0qG2fKq0timJ0YURCa+JIkFTGjZz4blsXt+tRVgu206Q+4+hVAZM2oxiN6oMRY6MuqceUJnXUzpUOGBlZpTE8xiVEMT1YVsM6AgZOT9WftRJm/i8swqJVQ6qE8PvyUnFo/6Eva31XPz/Pra7sqmJ4b0SzL0D5sEDl1EBVYyel22tTNiNCc0D109IFR83HPs7EDbb82EbpJivMPqgqum11FPY3kcl+kzxRf8kJwtKA1Mxr6E+UD8/Vd70osCYtVz5FlD6cE9KOcTvh/VdLazO8v5Rj8VbOgN1Tlty0CAeCEX/f1K/jc6C/7zltyaIqId1FB+OYC1GZ1e3FlAF0Ktg4UJ9oDLCCrHemyNEYVT0/pJzZzNA70+DIIAM7Wx1ZdjmNED2cIT/yQk9H5TsX1cDMf9gJMIN3Q6roEwwGpYzLGTsM4nPyAWoI72Uh/cCVpqYOT303Lehnt8twimSuQh5wEzADr7IKh/nlTERf0Xvxqckxt8zXgnToQrye1oqKPifUR95e/6Z11E/8eEkC/I7FbK3hL0xjJBFAqDnd4ro2DDuULY2/9Pczi4kNglmCyrWIMy9JRtyBHR1TKMcZVqkEmVBaWAQ9Gv04891T8+GNYv8Ua1Sq5qeMcIw8hyifNPJcgL+DQSMGJ6SQsPBXHitYvqND3M28A2sc3sp3yOJyCk3h0z8R2Q7HrFeAX9gn8rH6ILad4TSxP/RmKNUmfv4U0sS2DdSs3QCVvmB95FSXow89Ob827z4aNSyUHr2xXC+AId3FKnKuseKyKT+YqWLPc/NTQejB7sb6RT8t/Ue9fCqyFQus3qVHFzYUnRWITG911eaKpPexUyR4RBtcw2sJWNE6KqbK731kvb7Y3MnYPQAmDKBWcVYI7A4A8KBrf4m5T9cdKsIAwAq0EX6XniuL99iosvGKN77qdKGLt0m+EsqDU6kzH2uUJp+QblTKA5Gomc9UGkoM6oGsFMNARYeJr23Kw1m39tEjL7sfjxPeZhTJbA6e09pmAvZBBpBY/7ye8VhtKBzYHRmL38IY8pQfTPmTrc/65tYFx8QcYwRaynUGb+DU3se1vPw/8lYmXzd6Bmjup1XQBmIQ1gw/9JZsU5k6mtYD61CZxUS1jFotFCnxUpEnPWkgHTY6pl4w8Q0bPiPW2AwLCpZhwc8K4IZMO3SCOj0qHQwFSOBhxqECTWLfvRqWFRgBCbcfGt3PcPMHAKX+MF6j/8kBXNi+VpK93ZWLscesZnKVA0EiUZHBckDoxGjFSMfevpuytsfpJ2Uj0VQVBB6bYQUFdAbFPQs/udGCBojI50CAudHEKVDrUE9Yi2GXhzjx1GKj//PB3VOHuFee9qJtuGZLxOh3mXOh6pJmTFN0x5HKN7WiGxUo+1oo/AAP0zitHV4bCmjM+o3v5XfvLPyss5z7oEqrkiwqcigMj2SuNwOIO+d5LLoGsR5lXsX5KWP08XIeM/mVB5Z71fKE8Rp8t4pF1/uO/ZMYTVt49PkxRvseUa6zLJkxdVQQw011FBDR4Bz/w/sNqE8XK8ziwAAAABJRU5ErkJggg==\",\n \"hostedPaymentPage\": {\n \"id\": 2,\n \"pageName\": \"Test Page Name\",\n \"organizationId\": 22448,\n \"status\": true,\n \"createDateUtc\": \"2024-06-05T14:16:19.163\",\n \"modifiedDateUtc\": \"2024-06-06T19:39:05.083\",\n \"insertDate\": \"2024-06-05T10:16:19.163\",\n \"companyName\": \"Test Company Name\",\n \"category\": \"Test Category\",\n \"amountBehaviorId\": 1,\n \"amount\": 99999999,\n \"paymentTypes\": \"VMAXD\",\n \"termsAndConditionsUrl\": \"https://www.yoursite.asdf\",\n \"privacyPolicyUrl\": \"https://www.yoursite.asdf\",\n \"successfulPaymentUrl\": \"https://www.yoursite.asdf\",\n \"failedPaymentUrl\": \"https://www.yoursite.asdf\",\n \"primaryColor\": \"#48BAC9\",\n \"pageBackgroundColor\": \"#F5F9FA\",\n \"sectionBackgroundColor\": \"#FFFFFF\",\n \"headerTextColor\": \"#48BAC9\",\n \"paymentDetailsTextColor\": \"#48BAC9\",\n \"textColor\": \"#527C81\",\n \"displayDivider\": true,\n \"c2pEnabled\": false,\n \"c2pDpaId\": \"48a86b7a-bba6-4c83-9d14-d681ef4f01fd\",\n \"c2pDpaUri\": \"https://www.mysite.com\"\n }\n}"}],"_postman_id":"838f19c6-cd3b-4a56-898a-a10cfcad48a0"},{"name":"Delete Logo Image","id":"458ab212-ff89-4286-85e8-4d34f2e1aacd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####/Image/logo","description":"

The Delete Logo Image request is used to remove a logo image from an existing payment page.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["Hosted.Payment.Page.API","api","PaymentPage","#####","Image","logo"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"1a1acecb-e5f5-4095-be01-ec955a457019","name":"Delete Logo Image","originalRequest":{"method":"DELETE","header":[],"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####/Image/logo"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Image logo has been deleted for [HostedPaymentPageId: 2]."}],"_postman_id":"458ab212-ff89-4286-85e8-4d34f2e1aacd"},{"name":"Get Logo Image","id":"5b584a12-375f-42f6-9dcf-7878d504ab53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####/Image/logo","description":"

The Get Logo Image request is used to retrieve the existing logo image on a payment page.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["Hosted.Payment.Page.API","api","PaymentPage","#####","Image","logo"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"159c69ad-b74b-47f1-83f7-b92ae0e18c0d","name":"Get Logo Image","originalRequest":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage/#####/Image/logo"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Displayes the current image for your Hosted Payment Page."}],"_postman_id":"5b584a12-375f-42f6-9dcf-7878d504ab53"}],"id":"c578f3bb-52dc-401b-abf0-b20769539f00","description":"

The following requests allow you to create and edit your Hosted Payment Page for a Merchant Account. It is where you set your look and feel and other information for your Hosted Payment Page.

\n","_postman_id":"c578f3bb-52dc-401b-abf0-b20769539f00","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}}},{"name":"BridgePay AuthToken","item":[{"name":"BridgePay AuthToken","id":"3e9301a5-6128-487a-8cbd-9df14d4cd327","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"SOAPAction","value":"\"http://bridgepaynetsecuretx.com/authenticationservice/IAuthenticationService/AcquireAuthenticationToken\""},{"key":"Content-Type","value":"text/xml; charset=\"UTF-8\""}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n #####\r\n Hosted Payment Page Live\r\n #####\r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://www.bridgepaynetsecuretest.com/PaymentService/AuthenticationService.svc","description":"

The BridgePay AuthToken request is used to generate a single use AuthToken to be used in the query string for the hosted payment page.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}},"urlObject":{"protocol":"https","path":["PaymentService","AuthenticationService.svc"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"86c5009e-c2bc-4d04-ac94-cc728043b76a","name":"BridgePay AuthToken","originalRequest":{"method":"POST","header":[{"key":"SOAPAction","value":"\"http://bridgepaynetsecuretx.com/authenticationservice/IAuthenticationService/AcquireAuthenticationToken\""},{"key":"Content-Type","value":"text/xml; charset=\"UTF-8\""}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n #####\r\n Hosted Payment Page Live\r\n #####\r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://www.bridgepaynetsecuretest.com/PaymentService/AuthenticationService.svc"},"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":""}],"cookie":[],"responseTime":null,"body":"\r\n \r\n \r\n fef258cc-d87a-49c8-8839-c3997e6c523a\r\n \r\n \r\n"}],"_postman_id":"3e9301a5-6128-487a-8cbd-9df14d4cd327"}],"id":"0856bd2e-c786-4e81-8ab1-beb37e70e5f3","description":"

The following requests allow you to create a BridgePay AuthToken that can be used within your Query String Parameter to authorise the URL for processing a payment.

\n","_postman_id":"0856bd2e-c786-4e81-8ab1-beb37e70e5f3","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","name":"Specific Request Layouts","type":"folder"}}}],"id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754","description":"

The following sections outline the requests available for each endpoint.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"05ba3306-a61e-48d0-a80a-97880db46ce5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"45fe5924-c9cd-4665-9a1f-a485cf7812cf"}}],"_postman_id":"6e0c75d3-c92b-45b7-ab99-fbb25e624754"},{"name":"Appendix","item":[],"id":"558f686c-0dfa-4833-960e-3a2f996db1d2","description":"

For additional information on using the Hosted Payment Page, please visit our Developer Center: Hosted Payment Page - Advanced Options

\n

Test Credit Card Numbers

\n

Test Credit Card Numbers

\n

Test Credit Card Numbers (Click To Pay)

\n

Test Credit Card Numbers (Click To Pay)

\n

Test Dollar Amount Ranges

\n

Test Dollar Amount Ranges

\n

AVS and CVV Information

\n

Handling of CVV and AVS responses

\n

Certification Script

\n

BridgePay Gateway Certification Script

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Legend
R = Required
O = Optional
C = Conditional
1 = Required if not sending Track Data
3 = ACH/Checks
\n

Document Version:

\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):
1.0.1Noah HippensteelAdded and edited verbiage throughout the documentation.
1.0.0Mark MauerCreation of the full API documentation.
\n
","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f7643658-7dda-4430-8fec-f6db96411a5a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6185dbeb-34fb-45d0-b170-c0ad61e3209c"}}],"_postman_id":"558f686c-0dfa-4833-960e-3a2f996db1d2"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]}},"event":[{"listen":"prerequest","script":{"id":"d3a9fc10-6230-4fd4-909a-fe7452d34f41","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"97a3808f-287a-4f30-907d-c3d9042bc975","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"www.bridgepaynetsecuretest.com","type":"string"},{"key":"publicApiKey","value":"#####","type":"string"},{"key":"application","value":"Hosted Payment Page Live","type":"string"},{"key":"organizationId","value":"#####","type":"string"},{"key":"username","value":"#####","type":"string"},{"key":"password","value":"#####","type":"string"},{"key":"privateKey","value":"#####","type":"string"},{"key":"hppid","value":"#####","type":"string"},{"key":"imageType","value":"logo","type":"string"}]}