{"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":"Overview","item":[{"name":"Connection Strings","item":[],"id":"2a66a79d-0824-49a1-9999-92f8c88b74eb","description":"

The following endpoints are used for each section of the Hosted Payment Page API.

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

Examples:
API Authentication Setup	https://www.bridgepaynetsecuretest/api/ApiAuthentication
Payment Page Setup	https://www.bridgepaynetsecuretest.com/Hosted.Payment.Page.API/api/PaymentPage
Authentication	https://www.bridgepaynetsecuretest.com/PaymentService/AuthenticationService.svc

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6ed62bc1-21bf-43a4-ac67-e8cbe212055f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"edda0b75-0295-453c-b9be-49191e733291"}}],"_postman_id":"2a66a79d-0824-49a1-9999-92f8c88b74eb"},{"name":"Key Elements","item":[],"id":"72df1c3d-908b-469c-9158-dba813952483","description":"

The Hosted Payment Page API request and response structure is made up of a core set of data elements plus specific objects and their sub-elements.

The API has multiple endpoints for different functionality. A list of all required and optional data elements for each endpoint can be found in the Request & Response Information section.

In the live environment, transactions must be initiated over an SSL-protected connection using a minimum of 128-bit encryption to protect sensitive data. Initial testing can be performed over an unencrypted connection; however, testing must be performed over an SSL-encrypted channel before a client can be certified to production. Only test card/ACH account data may be transmitted. No live payment information should ever be transmitted to the test system.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9a3f1fa8-6daf-4769-b54c-77222e3c560b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7baca98c-bfe4-4658-8d05-e3509a93d5d5"}}],"_postman_id":"72df1c3d-908b-469c-9158-dba813952483"},{"name":"Process Flow","item":[],"id":"542d93ab-24c1-4779-97d9-e0692dbf5403","description":"

The Hosted Payment Page API uses a simple request and response process via HTTP POST. The order of operations is to configure and send your HTTP POST request and consume the response as desired.

Common response consumption practices are to retain the AcquireAuthenticationTokenResult and id for follow on transactions.

In order to setup a Hosted Payment Page, the user must have the \"Hosted Payment Page Tab\" right enabled in a role and attached to their user. Without this, the API calls will fail.

The API uses the following workflow:

Enable Hosted Payment Page functionality on your user account.
\n
1. This can be done in the UI following these instructions.
\n
Enable the Hosted Payment Page on the Merchant Account Code
\n
1. This can be done in the UI following these instructions.
  \n
2. This can also be done using the API Authentication process in this guide.
  \n
\n
Create a Payment Page template
\n
1. This can be done in the UI following these instructions.
  \n
2. This can also be done using the Create/Update Hosted Payment Page process in this guide.
  \n
\n
Create a BridgePay AuthToken
\n
1. This must be done via API for each instance of the payment page.
  \n
2. The value is then used in step 4 to create a Query String and generate the payment page.
  \n
\n
Generate a Query String
\n
1. Use the Query String to navigate to the payment page and process a payment.
\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b96be21b-fb92-44b9-a50d-dd6c94aadce6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1f31fc1f-ce2d-4b4a-b264-8030acd7b44c"}}],"_postman_id":"542d93ab-24c1-4779-97d9-e0692dbf5403"},{"name":"Authentication Information","item":[],"id":"c2feea39-0784-49f9-8e3f-bfe4e8a3e117","description":"

Each call to the API requires credentials. The Credentials object is used as a property of other objects in the API.

The Create Payment Page and Update Payment Page requests use a basic username and password.

The BridgePay AuthToken request uses a public and private key that is setup in the MyBridgePay gateway.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"41a6feb9-c3f4-4bd4-8d05-2aa1d09481ff"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5b02fa66-0e7c-427c-b2d0-22821e003c6e"}}],"_postman_id":"c2feea39-0784-49f9-8e3f-bfe4e8a3e117"}],"id":"a5ec9f4c-9fbb-4a8a-ad61-3c6fbdcd4024","description":"

The following guide outlines how to use the BridgePay Hosted Payment Page. The Hosted Payment Page is a customizable payment page that can be branded and used to collected payments online. It supports Credit, ACH and Mastercard Click to Pay.

Note that some steps in this guide require access to the MyBridgePay gateway user interface.

\n","event":[{"listen":"prerequest","script":{"id":"9bfc337e-da47-44ba-8609-76a3a39d7030","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7192bc8e-8f74-41b3-ae60-c9726674924d","type":"text/javascript","exec":[""]}}],"_postman_id":"a5ec9f4c-9fbb-4a8a-ad61-3c6fbdcd4024","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"ffe19b4a-3035-4377-9e80-829a0c6fe724","id":"ffe19b4a-3035-4377-9e80-829a0c6fe724","name":"Hosted Payment Page Development Guide","type":"collection"}}},{"name":"Request & Response Information","item":[],"id":"199793e8-150a-40f9-a71b-e6d5c0f0d095","description":"

\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

Because this guide leverages multiple endpoints with different payloads, each section in the Request Layouts will contain a table indicating the required fields.

\n","event":[{"listen":"prerequest","script":{"id":"1cbe30e4-0b28-4547-bb05-8292269e9d52","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"28d749e6-8ad3-4465-a334-b7e5659ed370","type":"text/javascript","exec":[""]}}],"_postman_id":"199793e8-150a-40f9-a71b-e6d5c0f0d095","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"ffe19b4a-3035-4377-9e80-829a0c6fe724","id":"ffe19b4a-3035-4377-9e80-829a0c6fe724","name":"Hosted Payment Page Development Guide","type":"collection"}}},{"name":"Specific Request Layouts","item":[{"name":"API Authentication","item":[{"name":"CreateApiAuthentication","id":"c70ee27d-b88a-4156-9973-e7bfbd371c99","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.

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

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

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

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

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

The following requests are used to create your publicKey which is used to obtain an AuthToken using the BridgePay AuthToken request. In order to create a publicKey, you will need to:

Access the MyBridgePay portal
\n
Navigate to the Account Management Tab (Left Navigation)
\n
Navigate to the Merchant Account Level
\n
Click Processing Applications Tab
\n
Enable Hosted Payment Page
\n
Save
\n

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. The value must be \"2\" for the 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.
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":"c09f4add-bf63-4279-8e5d-3e452e457928","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","name":"Specific Request Layouts","type":"folder"}}},{"name":"Create/Update Hosted Payment Page","item":[{"name":"Create Payment Page","id":"015fe589-b185-4aae-9b08-7cf32bef891e","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.

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

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":"840a6352-26f6-4f4f-9e57-a73da26d74ca","id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","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":"d98584f4-494f-4d05-a2f3-bf386ef4db84","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":"0299d7e7-5d67-46f9-9e57-f8c9ed582796"},{"name":"Delete Logo Image","id":"ca57da4e-7afc-4609-81d5-ade784a550c0","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.

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

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.

Create/Update Payment Page Request Information

The following data elements are available for use in the Create and Update Payment Page 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Length	Description
R	amountBehaviorId	Integer		Set to \"1\" to use Query String Parameters. Additional setting will be added in future releases.
C	applicationType	Integer	1	1 = TokenPay 2 = Hosted Payment Page Live
C	c2pDpaUri	String	2048	Click to Pay DPA website URI, a mobile application identifier, or another unique identifier (UUID, URL, APK package name, etc.).
R	c2pEnabled	Boolean		This flag indicates that If Click to Pay is enabled on the request model, saves the new DPA info with Click to Pay.
O	category	String	50	The category of the payment. Will appear blank on the Hosted Payment Page if left blank. Alphanumeric only and can contain the following special characters -/$”#&
O	companyName	String	50	The name of your company. Will appear blank on the Hosted Payment Page if left blank. Alphanumeric only and can contain the following special characters -/$”#&
O	displayDivider	Boolean		Determines if the thick divider line is displayed on the Hosted Payment Page.
R	failedPaymentUrl	String	2048	The URL a customer is taken to after a failed payment.
R	headerTextColor	String	7	The Hex Code (#RRGGBB) for the Hosted Payment Page header text color. Examples: Black: #000000 White: #FFFFFF Red: #FF0000 Blue: #0000FF
C	iframeDomainUrl	String	2048	The domain URL that the iframe will be hosted on. This is required for iframe use. Required if iframeSupport is set to true.
O	iframeSupport	Boolean		Setting this to true will allow the Hosted Payment Page to use an iframe implementation. If not set to ture, the hosted iframe will display an error and processing payments will not be possible.
C	organizationId	Integer		The organizationId of the Merchant Account you are creating/updating the Hosted Payment Page for.
R	pageBackgroundColor	String	7	The Hex Code (#RRGGBB) for the Hosted Payment Page background color. Examples: Black: #000000 White: #FFFFFF Red: #FF0000 Blue: #0000FF
R	pageName	String	50	The name of the page. This is not displayed on your live page. Alphanumeric only and can contain the following special characters -/$”#&
R	paymentDetailsTextColor	String	7	The Hex Code (#RRGGBB) for the Hosted Payment Page payment details text color. Examples: Black: #000000 White: #FFFFFF Red: #FF0000 Blue: #0000FF
R	paymentTypes	String	10	Used to choose which payment types are supported on the Hosted Payment Page. V: Visa M: Mastercard X: American Express D: Discover A: ACH Examples: Select all: VMXDA or MXDAV Omit Visa only: MXDA or DAXM
R	primaryColor	String	7	The Hex Code (#RRGGBB) for the Hosted Payment Page primary color. Examples: Black: #000000 White: #FFFFFF Red: #FF0000 Blue: #0000FF
R	privacyPolicyUrl	String	2048	The URL of the Privacy Statement link on the Hosted Payments Page.
R	sectionBackgroundColor	String	7	The Hex Code (#RRGGBB) for the Hosted Payment Page section background color. Examples: Black: #000000 White: #FFFFFF Red: #FF0000 Blue: #0000FF
R	status	Boolean		Status of the hosted payment page True = Activated False = Deactivated
R	successfulPaymentUrl	String	2048	The URL a customer is taken to after a successful payment.
R	termsAndConditionsUrl	String	2048	The URL of the Terms and Conditions link on the Hosted Payments Page.
R	textColor	String	7	The Hex Code (#RRGGBB) for the Hosted Payment Page text color. Examples: Black: #000000 White: #FFFFFF Red: #FF0000 Blue: #0000FF

Create/Update Payment Page Response Information

The following data elements are returned when using the Create and Update Payment Page 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Description
amount	Will be returned as null. Will be used in future releases.
amountBehaviorId	How an amount is set for the hosted payment page.
c2pDpaUri	Click to Pay DPA website URI, a mobile application identifier, or another unique identifier (UUID, URL, APK package name, etc.).
c2pEnabled	This flag indicates that If Click to Pay is enabled on the request model, saves the new DPA info with Click to Pay.
category	The category of the payment. Will appear blank on the Hosted Payment Page if left blank.
companyName	The name of your company. Will appear blank on the Hosted Payment Page if left blank.
displayDivider	Determines if the thick divider line is displayed on the Hosted Payment Page.
failedPaymentUrl	The URL a customer is taken to after a failed payment.
headerTextColor	The Hex Code (#RRGGBB) for the Hosted Payment Page header text color.
id	The ID of the Hosted Payment page created or updated.
organizationId	The organizationId of the Merchant Account you created/updated the Hosted Payment Page for.
pageBackgroundColor	The Hex Code (#RRGGBB) for the Hosted Payment Page background color.
pageName	The name of the page. This is not displayed on your live page.
paymentDetailsTextColor	The Hex Code (#RRGGBB) for the Hosted Payment Page payment details text color.
paymentTypes	Used to choose which payment types are supported on the Hosted Payment Page. V: Visa M: Mastercard X: American Express D: Discover A: ACH Examples: Select all: VMXDA or MXDAV Omit Visa only: MXDA or DAXM
primaryColor	The Hex Code (#RRGGBB) for the Hosted Payment Page primary color.
privacyPolicyUrl	The URL of the Privacy Statement link on the Hosted Payments Page.
sectionBackgroundColor	The Hex Code (#RRGGBB) for the Hosted Payment Page section background color.
status	Status of the hosted payment page True = Activated False = Deactivated
successfulPaymentUrl	The URL a customer is taken to after a successful payment.
termsAndConditionsUrl	The URL of the Terms and Conditions link on the Hosted Payments Page.
textColor	The Hex Code (#RRGGBB) for the Hosted Payment Page text color.

","_postman_id":"004c7396-b2ae-494b-b6c2-ff7b7343ea49","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","name":"Specific Request Layouts","type":"folder"}}},{"name":"BridgePay AuthToken","item":[{"name":"BridgePay AuthToken","id":"676dce81-9183-4744-9d48-e986c3a70279","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.

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.

BridgePay AuthToken Request Information

The following data elements are available for use in the BridgePay AuthToken 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

Required	Data Element	Data Type	Description
R	publicApiKey	guid	The public API key generated in the API Authentication step.
R	application	string	The application to which you intend to generate an authToken. The value for this API is: Hosted Payment Page Live
R	organizationId	integer	A numerical value indicating the id of the merchant account on which you intend to use the AuthToken.

BridgePay AuthToken Response Information

The following data elements are returned when using the BridgePay AuthToken requests.

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

Data Element	Data Type	Description
AcquireAuthenticationTokenResult	guid	A guid to be used as an AuthToken in a future Query String URL.

","_postman_id":"94bc9e0b-0224-44e0-a0af-dd3c0ba49da4","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","name":"Specific Request Layouts","type":"folder"}}},{"name":"Query String Parameter","item":[],"id":"08890a45-26e4-4cb1-aa82-d2068494066b","description":"

The following information details how to build out your Query String Parameter so that the cardholder can be directed to the Hosted Payment Page.

Basic URL Creation

In MyBridgePay, navigate to the following page:

Account Management
\n
Drill Down to the Merchant Account
\n
Click the Hosted Payment Page tab.
\n

This page will give you your basic page URL. It will look similar to this:

https://{mySite}/hpplive/paymentpage/{hppId}

This URL requires the amount of the transaction and an authToken generated in the previous section. The amount is added in the following format “?amount=12.34” to the end of the URL. The authToken is added as another element delimited by a \"&\" character.

Example:

https://{mySite}/hpplive/paymentpage/{hppId}?amount={amount in 00.00 format}&authToken=5f54f351-b0fa-4dcf-b316-b1cd8fa5f014

Additional Field Sending

It is possible to send additional information in the query string to be captured in gateway reports and provided to the payment processor. The additional information will be added after the “?amount=12.34” with an “&” followed by the field you wish to include from your website.

This data is sent to the MyBridgePay gateway and the connected processor. The supplied data will not appear on the Hosted Payment Page form.

The following table lists the additional fields that can be sent in a query string. All fields are optional.

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

Field	Query String Parameters	Count	Details
Amount	?amount=12.34	8	The amount requested for payment. Largest amount supported is 999999.99.
Invoice Number	&InvoiceNumber=123456789012345678901234	24	Invoice number. Spaces are not allowed. Alphanumeric and dashes accepted. User supplied data.
PO Number	&PurchaseOrderNumber=123456789012345678901234	24	Alphanumeric and dashes accepted. User supplied data.
Customer ID (Number)	&CustomerAccountCode=123456789012345678901234	24	Alphanumeric and dashes accepted. User supplied data.
Email Address	&emailAddress=john.smith@example.com	100	Account holder’s e-mail address provided in the transaction request.
Mobile Phone	&mobileNumber=1234567890	10	The phone number provided in the transaction request.

Here is an example URL with all of the additional fields added to it:

UAT:
https://www.bridgepaynetsecuretest.com/hpplive/paymentpage/{hppId}?amount=12.34&InvoiceNumber=123456789012345678901234&PurchaseOrderNumber=123456789012345678901234&customerAccountCode=123456789012345678901234&emailAddress=john.smith@example.com&mobileNumber=1234567890&authToken=5f54f351-b0fa-4dcf-b316-b1cd8fa5f014

URL Return of referenceNumber

When the transaction completes, the gateway transaction ID will appear in the resulting URL as follows:

Successful Payment:

{Successful Payment URL}/?referenceNumber=4592909104

Failed Payment:

{Failed Payment URL}/?referenceNumber=4592909104

\n","_postman_id":"08890a45-26e4-4cb1-aa82-d2068494066b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","name":"Specific Request Layouts","type":"folder"}}}],"id":"840a6352-26f6-4f4f-9e57-a73da26d74ca","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":"840a6352-26f6-4f4f-9e57-a73da26d74ca"},{"name":"Appendix","item":[],"id":"9414aeb9-cd23-4e67-83cd-fe1dbe54900d","description":"

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

Test Credit Card Numbers

Test Credit Card Numbers (Click To Pay)

Test Dollar Amount Ranges

AVS and CVV Information

Handling of CVV and AVS responses

Certification Script

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

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

Document Version:

\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.1	Noah Hippensteel	Added and edited verbiage throughout the documentation.
1.0.0	Mark Mauer	Creation of the full API documentation.

","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":"9414aeb9-cd23-4e67-83cd-fe1dbe54900d"}],"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"}]}