The BridgePay Public Reporting API provides consumers with the ability to request transaction data via a SOAP request made to the service. The user can provide data they wish to use as a filter in the parameter to the SOAP method and will receive a response containing the data they requested.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"24667e13-7bf9-4506-8050-2c09806715a2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b013b649-6062-4176-a6dd-28825ce51274"}}],"_postman_id":"a9eb075c-4db3-4983-915f-09a4226d58d6"},{"name":"Connection Strings","item":[],"id":"43b6b009-e59a-4238-8199-eb7d8f46eff8","description":"The reporting service can be accessed on BridgePay’s test server at the following service address:
\nhttps://www.bridgepaynetsecuretest.com/Reporting.API/ReportingAPI.svc
\nTo obtain the service definition, simply add ?wsdl to the end of the service address.
\nhttps://www.bridgepaynetsecuretest.com/Reporting.API/ReportingAPI.svc?wsdl
\nPlease Note: The latest version (highest number) of the API should be used for new integrations, olderversions are left in place in order to not invalidate previous integrations.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a56a5c8f-7d7e-422a-a171-5bf73e188f14"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"70192912-27b5-40ae-a97a-7c155f260df1"}}],"_postman_id":"43b6b009-e59a-4238-8199-eb7d8f46eff8"},{"name":"Key Elements","item":[],"id":"361bc5b4-fd21-4a26-a143-df012b3ee4a6","description":"Skip and Take fields are required when calling the API. Transaction Rows and Batch Details will be limited to 1000 at a time. Using take and Skip you can obtain larger data sets in multiple calls. For instance, if 1,500 records are available based on the filter information sent in, the first 1000 records would be obtained by sending in 1000 for Take and 0 for skip. The next 500 records would be obtained by sending in Take for 500 and skip for 1000. See the code example at the end of this document for an
example
The Reporting API provides three data contracts. One for the incoming request and two for the response from the request. When making a request, the consumer must provide a TransctionRowFilter object. When receiving the response, the consumer will get a TransactionSet object which will contain a collection of TransactionRow objects. Because of the similarities between V1 and V2, information for V2 has been included in the TransactionRowFilter. The data contracts are described in more detail below.
\nAt this time, the Public Reporting API v1 provides only one operation contract for retrieving transactional data.
\nThe Reporting API provides two data contracts. Two for the incoming request and two for the response from the request. When making a PublicGetBatchListByFilter request, the consumer must provide an OrgBatchListFilter object. When receiving the response, the consumer will get an OrgBatchListSet object which will contain a collection of OrgBatchListDetail objects. When making a PublicGetTransactionsByFilterV2 request, the consumer must provide a TransctionRowFilter V2 object. When receiving the response, the consumer will get a TransactionSet object which will contain a collection of TransactionRow objects. The only differences between V1 and V2 of PublicGetTransactionsByFilter is a deprecated field (SortBy) has been removed and ContractID has been added. Please refer back to TransactionRow information in V1 for the V2 field changes. The BatchList data contracts are described in more detail in the Request and Response Information Section.
\nAt this time, the Public Reporting API v2 provides two operation contracts for retrieving transactional data and batch details.
\nCredentials are required to access the Public Reporting API. Please reach out to your integration analyst to obtain them.
\nA test or live merchant account with BridgePay is necessary to successfully process transactions. To acquire a test account, complete the test account request form located on the BridgePay Integrator Support Portal.
\nTo review additional documentation, please visit the Developer Center. For Integrations Assistance, please Enter a Case.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2ac42416-02bc-41dd-af8a-b052eb1459ff"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5712b78b-4300-42e7-a2de-7ca8b7c49fb3"}}],"_postman_id":"3e226e13-f42e-4e22-a9ac-64720737641d"},{"name":"Request & Response Information","item":[],"id":"247681ae-ae1d-4240-907c-7c83a4cac535","description":"Note: The TransResults field works by mapping the BridgeComm 5-digit response code back to the gateway response code (the ResponseCode field in this contract). In some cases, more than one mapping may exist for a given code. It is recommended that you use the ResponseCode field for more granular filtering.
\nThe ExcludeTransResults field can modify the behavior of the TransResults field by establishing a “not in” condition. See the Helpful Tips section for more information.
\nFor more information about the 5-digit BridgeComm response codes, see the BridgeComm documentation.
\nA set of transaction rows returned by the provided filter data.
\nA transaction returned within a set, can be one or many.
\nThe V2 request allows for the same fields as V1 with the addition of the following:
\nThe V2 request returns the same fields as V1 with the addition of the following TransactionRow element:
\nA set of batches returned by the provided filter data.
\nA batch returned by the provided filter data.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"67fb956f-712a-4862-8e06-cc9dc18d7014"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4437a2ce-e602-4cca-adf6-743780e48798"}}],"_postman_id":"247681ae-ae1d-4240-907c-7c83a4cac535"},{"name":"Specific Request Layouts","item":[{"name":"PublicGetTransactionsByFilterV1","event":[{"listen":"prerequest","script":{"id":"967b6d6d-2b94-4040-8a83-8f32849c2480","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"f7750278-cd27-4693-b7b3-cb03b80d789a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"793dec55-0d67-4b9d-adab-1a481832a8b5","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true,"content-type":true,"user-agent":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v1/IReportingAPIV1/PublicGetTransactionsByFilter","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"V1 is only documented here for existing integrations. For all new Integrations, use V2.
\nPublicGetTransactionsByFilterV1 will return a list of transactions meeting the criteria of the provided filters.
\nNote that these examples show all data elements; however, in a valid request, only populated elements should be included.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v1"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"b504f3d6-3f5b-4169-82f4-58634d02b0b5","name":"PublicGetTransactionsByFiterV1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v1/IReportingAPIV1/PublicGetTransactionsByFilter","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"PublicGetTransactionsByFilterV2 will return a list of transactions meeting the criteria of the provided filters.
\nNote that these examples show all data elements; however, in a valid request, only populated elements should be included.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"a45d2f74-e951-4418-ae8e-3825d67b6fd3","name":"PublicGetTransactionsByFiterV2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"PublicGetBatchListByFilterV2 will return a list of batches meeting the criteria of the provided filters.
\nNote that these examples show all data elements; however, in a valid request, only populated elements should be included.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0c7f6f29-abd9-4880-84b6-87b308acb005","name":"PublicGetBatchListByFiterV2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetBatchListByFilter","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns all transactions for a Merchant Account/Merchant Account Code combination. This is used primarily to retrieve a total transaction count.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"8c2a0a4b-40a7-4acb-be17-4acebafa6aaa","name":"Transactions by MID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns a sale transaction based on the Reference Number/.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"af3667d0-86b5-44a7-8a2b-0f14245487a1","name":"Transactions by Reference Number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns all transactions based on a Merchant Account/Merchant Account Code combination within a specified date range.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v1"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"9f9aed18-d20d-47e3-ac4e-afa1b698afc5","name":"Transactions by MID and Date Range","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v1/IReportingAPIV1/PublicGetTransactionsByFilter","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns all transactions within a specified batch.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"41e1634e-b8f1-4745-8d8b-89a579470426","name":"Transactions by Batch Number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns all transactions for a Merchant Group. This is used primarily to retrieve a total transaction count.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"47121806-baac-4822-ae5b-85807f352222","name":"Transactions by Merchant Group","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns all transactions for a Merchant Group within a specified date range.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"c52dd934-8788-46b8-809a-1335511d34b8","name":"Transactions by Date Range by Merchant Group","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns a set of transactions ordered by the corresponding Key and Value pair provided in the OrderByList object. The pair are contained within a KeyBalueOfstringstring element as shown in the example below.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"8889a535-3847-4714-80f3-bd6de2a8e9df","name":"Transactions Sorted by Batch Number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"Returns a set of transactions ordered by the corresponding Key and Value pair provided in the OrderByList object. The pair are contained within a KeyBalueOfstringstring element as shown in the example below.
\n","urlObject":{"protocol":"https","path":["Reporting.API","ReportingAPI.svc","v2"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"bad31795-4664-4275-9453-2371f21a26e1","name":"Batches Sorted by Batch Number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"http://bridgepaynetsecuretx.com/reportingapi_v2/IReportingAPIV2/PublicGetTransactionsByFilterV2","type":"text"},{"key":"User-Agent","value":"Apache-HttpClient/4.1.1 (java 1.5)","type":"text"}],"body":{"mode":"raw","raw":"The following examples showcase the use of the Reporting API.
\nInclude only populated elements in your request. Unpopulated elements can result in an error. For any unused element, do not include it in your request.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"016adfff-7e95-4505-abd8-6f71255d95ae"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f518d399-bca4-4b03-b8ba-616728a971fa"}}],"_postman_id":"692151d6-8298-4dee-a468-46aa3ccfc834"},{"name":"Appendix","item":[],"id":"3c0862a6-c532-4730-a3ac-0dc10f6845a6","description":"There are two types of parameters in the TransactionRowFilter object: DBQuery Filters and Post-Query Filters.
\nMost of the parameters in the filter are DBQuery filters that are used directly against the persisted data store that contains the transactional data. However, some of the filters arePost-Query filters, meaning the filters are not applied until after the persisted data is retrieved. Post-query filters have transformational logic that is better suited after the bulk of the query has been processed by the data store.
\nFilters that are processed directly against the data store also have specific comparison modes that can be utilized for easier queries. Review the comparison modes listed in the TransactionRowFilter table for a full list.
\nGTE = Greater Than or Equal. The query will look for data that is greater than or equal to the data provided in the filter parameter.
\nLTE = Less Than or Equal. The query will look for data that is less than or equal to the data provided in the filter parameter.
\nEQUIV = Equals. The query will look for data that exactly matches the data provided in the filter parameter.
\nNOTEQUIV = Not Equal. The query will look for data that does not exactly matches the data provided in the filter parameter.
\nCONTAINS = The query will look for data that contains the data provided in the filter parameter.
\nNOTCONTAINS = The query will look for data that does not contain the data provided in the filter parameter.
\nINLIST = The query will look for data where the stored data matches one of the comma delimited entries in the data provided in the filter parameter.
\nN/A = The parameter is either a Boolean parameter or does not affect the data filtering process.
\nAmountRangeFrom = 100
\nAmountRangeTo = 200
\nInvoiceNumber = 2001
\nResponseCode = D
\nResponseCode = D0
\nResponseCode = D01
\nTransResults = 00000,00001,10012
\nExcludeTransResults = 1 must be used with TransResults.
\nThe following fields are Post-Query filters. They will not process until after the initial data store query has completed.
\nTransactionStatus
\nCardBrand
\nThe data used to query on these parameters must be transformed before the filter can be applied. The data store resources are too time-consuming for these filters and they are therefore added after the data store query is completed.
\nYou should never use a Post-Query Filter without first limiting the data store query with some DBQuery filters such as a date range and/or the merchant account information.
\n