{"info":{"_postman_id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","name":"Bulk Transaction API Guide","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"<html><head></head><body></body></html>","owner":"24254550","collectionId":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","publishedId":"2s9Ykn7giE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"336699"},"publishDate":"2023-12-15T16:55:47.000Z"},"item":[{"name":"Overview","item":[{"name":"Introduction","item":[],"id":"7855b8a3-58e6-4692-b868-21ee37520d5e","description":"<p>This guide will outline the use of the Bulk Transaction to import batches of credit card and/or ACH payments into one or more merchant accounts within the BridgePay Gateway using a CSV file.</p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bde9d1e7-cb45-41b4-80af-2d7251f56b63"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2b7b39a8-1067-4f8c-8612-93d4e86e7ef6"}}],"_postman_id":"7855b8a3-58e6-4692-b868-21ee37520d5e"},{"name":"Connection Strings","item":[],"id":"fb9115ec-17b6-4eac-9c1f-37db022013a8","description":"<p>The following endpoint will be the basis for all endpoints used by the API:</p>\n<p><a href=\"https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethodToken\">https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk</a></p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"5e90a8ab-c749-4399-af8b-93ad8f2e81b4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9cb24b47-73d1-4766-ab4c-375ae0e5f939"}}],"_postman_id":"fb9115ec-17b6-4eac-9c1f-37db022013a8"},{"name":"Key Elements","item":[],"id":"6e12abf8-aa51-4341-a35a-b1881937f38c","description":"<p>The Bulk Transaction API intakes a CSV file containing Credit Card or ACH transactions and queues the transactions for processing every 5 minutes. In response to the CSV file, the API will return an <strong>id</strong> value to use in future requests to get the status of the CSV file import.</p>\n<p>As the file works through the processing stages, its status will update to show the step in the process in which the import currently resides. These statuses can be reviewed with the <strong>Search CSV</strong> function.</p>\n<p>BridgePay recommends enabling duplicate checking on any Merchant Accounts intending to use the import transaction function to avoid transaction duplication from duplicated import files.</p>\n<p>The user account importing a CSV file via the Bulk Transaction API must have access to all Merchant Accounts included in the import file or the import will fail.</p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"547b1f26-5f55-483a-9d3a-5f79b115ed9c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7f442bc0-92c8-4585-b2f4-da810938ebb7"}}],"_postman_id":"6e12abf8-aa51-4341-a35a-b1881937f38c"},{"name":"Process Flow","item":[],"id":"43869e9c-68bc-4657-bb59-60ee26282cae","description":"<p>The import process involves 3 steps:</p>\n<ol>\n<li><p><strong>Create the Import File</strong></p>\n<ol>\n<li>The file must be saved in a CSV format. Download the <strong>Sample_Import_CSV_v1.csv</strong>.</li>\n<li>The format must follow the BridgePay Mandatory and Optional Fields Guide. Download the <strong>Import Transactions - Mandatory and Optional Fields Guide v1.0.xlsx.</strong></li>\n<li>Sample files above may be found <a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/246448178/Import+Transaction+Guidelines\">here</a>.</li>\n</ol>\n</li>\n<li><p><strong>Upload the File</strong></p>\n<ol>\n<li>Select your CSV file that is under 5MB.</li>\n<li>Once chosen, import your CSV file.</li>\n<li>The imported CSV file will be validated immediately, and transactions will process every five minutes.</li>\n</ol>\n</li>\n<li><p><strong>File Validation and Processing</strong></p>\n<ol>\n<li>BridgePay will validate your file to ensure that it is formatted correctly.</li>\n<li>If successful:<ol>\n<li>BridgePay Processes the provided transactions</li>\n<li>Results may be accessed via the <strong>Export Results JSON/CSV</strong></li>\n</ol>\n</li>\n<li>If unsuccessful:<ol>\n<li>Any validation errors will be updated to the <strong>id</strong> record. Use the <strong>Export</strong> or <strong>Search</strong> functions to view updates to an <strong>id</strong>.</li>\n</ol>\n</li>\n</ol>\n</li>\n</ol>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1362661e-1a3e-4a64-a7ed-2e3171b1519f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5d51d32a-bf98-441b-a735-e2cd2d263c78"}}],"_postman_id":"43869e9c-68bc-4657-bb59-60ee26282cae"},{"name":"Authentication Information","item":[],"id":"28a54793-e8e6-45c8-9d18-b3d54cb2780f","description":"<p>Each call to the API requires credentials for use with Basic Authorization via HTTPS. These credentials will include a <strong>username</strong> and <strong>password</strong> with appropriate permissions for processing transactions on the intended merchant account.</p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d77ccb76-b060-4ee3-9ee9-5edf02369487"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"007c8215-ac40-4ba8-80b5-08fcb1463924"}}],"_postman_id":"28a54793-e8e6-45c8-9d18-b3d54cb2780f"}],"id":"88870110-6f2d-41d5-8a14-59154a163d60","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"154db0a3-611f-45fb-8c96-5d51ee90262d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"876c5eee-1536-47a0-8886-f03179ddce8c"}}],"_postman_id":"88870110-6f2d-41d5-8a14-59154a163d60","description":""},{"name":"Request & Response Information","item":[],"id":"f7e1bb85-7268-4dfe-ad83-22a42986707d","description":"<h2 id=\"request\">Request</h2>\n<p>The following legend can be used to determine the required fields:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Legend</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>R</td>\n<td>Required</td>\n</tr>\n<tr>\n<td>O</td>\n<td>Optional</td>\n</tr>\n<tr>\n<td>C</td>\n<td>Conditional</td>\n</tr>\n<tr>\n<td>1</td>\n<td>Required for Credit Card Transactions</td>\n</tr>\n<tr>\n<td>3</td>\n<td>Required for ACH/Check Transactions</td>\n</tr>\n</tbody>\n</table>\n</div><p>The CSV file contains the following columns:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Name</th>\n<th>Requirement</th>\n<th>Data Type</th>\n<th>Length</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>transactionType</td>\n<td>R</td>\n<td>string</td>\n<td>11</td>\n<td>Possible values:  <br />sale,  <br />sale-auth, credit,  <br />credit-auth</td>\n</tr>\n<tr>\n<td>merchantAccountCode</td>\n<td>R</td>\n<td>integer</td>\n<td>N/A</td>\n<td>The Merchant Account Code for the gateway on which the transactions should be processed. Provided by MyBridgePay at time of Boarding.</td>\n</tr>\n<tr>\n<td>organizationId</td>\n<td>O</td>\n<td>integer</td>\n<td>4</td>\n<td>An alternative identifier for the account on which transactions should be processed.  <br />  <br />This value can be found via the Boarding API.</td>\n</tr>\n<tr>\n<td>acctType</td>\n<td>R</td>\n<td>string</td>\n<td>1</td>\n<td>Single character, must match pre-defined types:  <br />R (Credit Card &amp; Branded Debit Cards),  <br />D (Unbranded Debit Cards),  <br />S (Bank Account Savings),  <br />C (Bank Account Checking),  <br />F (EBT Food Stamp),  <br />H (EBT Cash Benefit),  <br />G (Gift Card),  <br />L (Fleet),  <br />K (Check),  <br />A (Cash)</td>\n</tr>\n<tr>\n<td>transactionID</td>\n<td>R</td>\n<td>string</td>\n<td>60</td>\n<td>Unique value to identify the transaction. Generated by the integrating application or by the Merchant.</td>\n</tr>\n<tr>\n<td>paymentAccountNumber</td>\n<td>1</td>\n<td>string</td>\n<td>13-19</td>\n<td>Credit card number.</td>\n</tr>\n<tr>\n<td>bankAccountNum</td>\n<td>3</td>\n<td>integer</td>\n<td>N/A</td>\n<td>The bank account number for ACH and Check transactions.  <br />  <br />Must contain at least one number.</td>\n</tr>\n<tr>\n<td>routingNum</td>\n<td>3</td>\n<td>integer</td>\n<td>10</td>\n<td>The routing number for ACH and Check transactions.  <br />  <br />Can contain up to 10 numbers.</td>\n</tr>\n<tr>\n<td>expirationDate</td>\n<td>1</td>\n<td>string</td>\n<td>7</td>\n<td>Expiration date of the card.  <br />  <br />Supported formats are: MMYY and MM/YY.</td>\n</tr>\n<tr>\n<td>securityCode</td>\n<td>O</td>\n<td>integer</td>\n<td>3-4</td>\n<td>3 or 4 digits long CVV / CVV2 of the card.</td>\n</tr>\n<tr>\n<td>amount</td>\n<td>R</td>\n<td>integer</td>\n<td>8</td>\n<td>The amount requested for authorization. Processed as implied decimal. $1.25 would be represented as 125.</td>\n</tr>\n<tr>\n<td>tipAmount</td>\n<td>O</td>\n<td>integer</td>\n<td>8</td>\n<td></td>\n</tr>\n<tr>\n<td>transIndustryType</td>\n<td>R</td>\n<td>string</td>\n<td>2</td>\n<td>Must either match a 2-letter industry type for credit cards or a 3-letter SEC code for ACH transactions. All caps.  <br />  <br />Credit Card Supported values are:  <br />RE (Retail),  <br />RS (Restaurant),  <br />EC (eCommerce),  <br />DM (Direct Marketing),  <br />LD (Lodging) and  <br />CR (Car Rental).  <br />  <br />HC is also supported for HealthCare, however internally transactions with industry type HC are converted to Retail (RE) transactions.  <br />  <br />ACH Supported values are:  <br />CCD (Corporate Credit or Debit),  <br />PPD (Prearranged Payment and Deposit Entry),  <br />POP (Point of Purchase Entry),  <br />TEL (Telephone Initiated Entry),  <br />WEB (Internet Initiated Entry),  <br />C21 (Check 21)</td>\n</tr>\n<tr>\n<td>accountStreet</td>\n<td>O</td>\n<td>string</td>\n<td>128</td>\n<td>The Street associated with the account.  <br />  <br />May contain alphanumerics, spaces, hyphens, periods and slashes.</td>\n</tr>\n<tr>\n<td>accountZip</td>\n<td>O</td>\n<td>string</td>\n<td>10</td>\n<td>The ZIP/Postal Code associated with the Payment Method Account.  <br />  <br />Accepted formats are Canadian, UK and US (5 and 9 digit variation) postal codes.  <br />  <br />Alphanumeric characters ONLY (no hyphens or dashes).  <br />  <br />Alpha characters must be all upper-case.</td>\n</tr>\n<tr>\n<td>softwareVendor</td>\n<td>R</td>\n<td>string</td>\n<td>N/A</td>\n<td>Name of vendor that developed the software used in transmitting the transaction.  <br />  <br />May only contain the following characters: a-z, A-Z, 0-9, spaces, and dashes.</td>\n</tr>\n<tr>\n<td>customerWalletID</td>\n<td>O</td>\n<td>string</td>\n<td>36</td>\n<td>The integrator provided ID representing the wallet payment method.  <br />  <br />When using this field, no other payment identifiers are necessary (i.e. walletPaymentMethodID, paymentAccountNumber, bankAccountNum, etc).</td>\n</tr>\n<tr>\n<td>walletPaymentMethodID</td>\n<td>O</td>\n<td>GUID</td>\n<td>36</td>\n<td>The ID generated by the Wallet API for the wallet payment method.  <br />  <br />When using this field, no other payment identifiers are necessary (i.e. customerWalletID, paymentAccountNumber, bankAccountNum, etc).</td>\n</tr>\n<tr>\n<td>[customFieldID]</td>\n<td>O</td>\n<td>string</td>\n<td>N/A</td>\n<td>One column may be added to the CSV for each custom field being sent where [customFieldID] is the ID of the custom field. This ID must be obtained via the Boarding API.</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"response\">Response</h2>\n<p>The response in either JSON or CSV format will contain the following fields:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Name</th>\n<th>Data Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>lineNumber</td>\n<td>integer</td>\n<td>The line number from the imported CSV for the relevant transaction row.</td>\n</tr>\n<tr>\n<td>requestType</td>\n<td>string</td>\n<td>The transactionType of the imported transaction (sale, sale-auth, credit, credit-auth)</td>\n</tr>\n<tr>\n<td>responseType</td>\n<td>string</td>\n<td>The response for the imported transaction.  <br />Values include:  <br />Approved - Approved Transaction  <br />Decline - Declined Transaction  <br />Processing Error - Processed with errors  <br />Validation Error - Not processed due to failed validation (see ProviderResponseMessage for more information)</td>\n</tr>\n<tr>\n<td>merchantAccountCode</td>\n<td>integer</td>\n<td>The Merchant Account Code entered for the imported transaction.</td>\n</tr>\n<tr>\n<td>organizationId</td>\n<td>integer</td>\n<td>The OrganizationID entered for the imported transaction</td>\n</tr>\n<tr>\n<td>gatewayTransId</td>\n<td>integer</td>\n<td>The gateway transaction id for the imported and processed transaction. This value can be used to search for the transaction in MyBridgePay or it may be used in the Transaction API for follow-on transactions.  <br />  <br />Transactions with validation errors will not contain a gatewayTransId.</td>\n</tr>\n<tr>\n<td>transactionId</td>\n<td>string</td>\n<td>The transactionId supplied in the CSV import for the transaction.</td>\n</tr>\n<tr>\n<td>last4</td>\n<td>string</td>\n<td>The last four digits of the credit card or bank account used in the transaction.</td>\n</tr>\n<tr>\n<td>transactionDate</td>\n<td>date</td>\n<td>The date and time at which the transaction was processed.</td>\n</tr>\n<tr>\n<td>amount</td>\n<td>integer</td>\n<td>The amount of the transaction in dollars as an implied decimal.  <br />  <br />Ex: $5.00 = 500</td>\n</tr>\n<tr>\n<td>tipAmount</td>\n<td>integer</td>\n<td>The amount of the transaction in dollars as an implied decimal.  <br />  <br />Ex: $5.00 = 500</td>\n</tr>\n<tr>\n<td>responseCode</td>\n<td>string</td>\n<td>The gateway response code for the transaction.  <br />  <br />Gateway Response Codes can be found <a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/246644751\">here</a>.</td>\n</tr>\n<tr>\n<td>providerResponseMessage</td>\n<td>string</td>\n<td>The response message from the gateway/processor. These values can vary.  <br />  <br />More information can be found <a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/246644751\">here</a>.</td>\n</tr>\n<tr>\n<td>actions</td>\n<td>string</td>\n<td>The status of the transactions. The following may appear:  <br />  <br />Processed - The transaction processed with the gateway, and could have received an Approval, Decline or Error. responseType column may be consulted to determine the end result.  <br />  <br />Resolve Errors in CSV and Reprocess Transaction - The transaction failed to validate and was not processed. Review the CSV import file for any data entry issues.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2db54303-2e3a-4cf5-87c5-68e71c124a5d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2e1d5d16-3e56-46c1-9665-2ce54351d3c3"}}],"_postman_id":"f7e1bb85-7268-4dfe-ad83-22a42986707d"},{"name":"Specific Request Layouts","item":[{"name":"Import CSV","event":[{"listen":"test","script":{"id":"53ec413d-3649-4449-a515-8d15daaee037","exec":["pm.test(\"Status code is 202\", function () {\r","    pm.response.to.have.status(202);\r","});\r","\r","pm.test(\"Id is nonzero\", function () {\r","    var jsonData = pm.response.json();\r","    pm.variables.set(\"bulkFileId\", jsonData.id);\r","    pm.expect(jsonData.id).to.not.eql(0);\r","});\r","\r","pm.test(\"Status is pending\", function () {\r","    var jsonData = pm.response.json();\r","    pm.expect(jsonData.status).to.eql(\"Pending\");\r","});\r","\r","pm.test(\"Filename is file.csv\", function () {\r","    var jsonData = pm.response.json();\r","    pm.expect(jsonData.filename).to.eql(\"file.csv\");\r","});\r","\r","pm.test(\"responseMessage is Accepted and queued\", function () {\r","    var jsonData = pm.response.json();\r","});"],"type":"text/javascript"}}],"id":"48ddfc68-5f36-44f0-bcd7-9ac175fcae21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","src":"TestFile.csv"}]},"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk","description":"<p>The Import function intakes a CSV file as the Body of the request. The Content-Type will be <strong>multipart/form-data</strong> and point to a CSV file via a file path. Example:</p>\n<p>C:/ABC123/DEF456/GHI789/file.csv</p>\n<p>As an additional example, the request would look like the following in a curl request:</p>\n<p><em>curl --location 'API_Url' --header 'Accept: text/plain' --header 'Authorization: Basic dXNlcjpwYXNzd29yZA==' --form \"file=@\"C:/Users/username/Documents/CSV_Files_Bulk_Transaction/CSV_test.csv\"\"</em></p>\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"[username]"},{"key":"password","value":"[password]"}]},"isInherited":true,"source":{"_postman_id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","name":"Bulk Transaction API Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Bulk.Transaction.API","api","Bulk"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"1dbc7532-908a-402b-bfd4-66204ef4ac6f","name":"Post CSV","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","src":"TestFile.csv"}]},"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": 106,\n    \"status\": \"Pending\",\n    \"filename\": \"TestImport_CSV.csv\",\n    \"responseMessage\": \"Accepted and queued\"\n}"}],"_postman_id":"48ddfc68-5f36-44f0-bcd7-9ac175fcae21"},{"name":"Import Information","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r","    pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Got record with ID.\", function () {\r","    var jsonData = pm.response.json();\r","    var id = parseInt(pm.variables.get(\"bulkFileId\"), 10);\r","    pm.expect(jsonData.id).to.eql(id);\r","});"],"type":"text/javascript","id":"35fa4c2e-0ab0-42a4-b734-182f57ab15c9"}}],"id":"8b829798-536a-4469-875b-e3c0f8bc5a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/[csvId]","description":"<p>The <strong>Import Information</strong> request intakes a CSV <strong>id</strong> in the request URL and returns the status information associated with this CSV <strong>id</strong>.</p>\n<p>This is comparable to the <strong>Search CSV</strong> function targeting a single CSV <strong>id</strong>.</p>\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"[username]"},{"key":"password","value":"[password]"}]},"isInherited":true,"source":{"_postman_id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","name":"Bulk Transaction API Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Bulk.Transaction.API","api","Bulk","[csvId]"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"ccfc3ab4-9907-4b34-851f-50443dcabd94","name":"Get Bulk Record","originalRequest":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/[csvId]"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": 104,\n    \"status\": \"Completed\",\n    \"filename\": \"TestImport_CSV.csv\",\n    \"userId\": 97187,\n    \"responseMessage\": \"Completed\",\n    \"receivedUtc\": \"2023-09-07T15:49:59Z\",\n    \"startedUtc\": \"2023-09-07T15:50:26Z\",\n    \"completedUtc\": \"2023-09-07T15:50:27Z\"\n}"}],"_postman_id":"8b829798-536a-4469-875b-e3c0f8bc5a46"},{"name":"Export Results JSON","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r","    pm.response.to.have.status(200);\r","});\r","\r","\r","\r","pm.test(\"Returns six transactions\", function () {\r","    var jsonData = pm.response.json();\r","    pm.expect(jsonData.length).to.eql(6);\r","});"],"type":"text/javascript","id":"b77df9b7-ff91-4a97-a6f0-514a41008041"}}],"id":"f0fb7ecd-2028-46de-a852-ad447e9f20f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/[csvId]/transactions?format=json","description":"<p><strong>Export Results</strong> will return the transaction results of a CSV <strong>id</strong> in JSON formatting.</p>\n<p>The <strong>id</strong> of the CSV should be provided in the URL as shown above with an additional query parameter of: <strong>format=json</strong></p>\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"[username]"},{"key":"password","value":"[password]"}]},"isInherited":true,"source":{"_postman_id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","name":"Bulk Transaction API Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Bulk.Transaction.API","api","Bulk","[csvId]","transactions"],"host":["www.bridgepaynetsecuretest.com"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[{"id":"73a0549f-9ba1-42de-9c77-c3d53883bbfe","name":"Export Results JSON","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/[csvId]/transactions?format=json","protocol":"https","host":["www.bridgepaynetsecuretest.com"],"path":["Bulk.Transaction.API","api","Bulk","[csvId]","transactions"],"query":[{"key":"format","value":"json"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"lineNumber\": 2,\n        \"requestType\": \"sale\",\n        \"responseType\": \"Declined\",\n        \"merchantAccountCode\": 1234567,\n        \"organizationId\": null,\n        \"gatewayTransId\": 79368704,\n        \"transactionId\": \"Line Number: 2\",\n        \"last4\": \"1111\",\n        \"transactionDate\": \"2023-11-30T00:00:00-05:00\",\n        \"amount\": 1,\n        \"tipAmount\": null,\n        \"responseCode\": \"30032\",\n        \"providerResponseMessage\": \"Denied by customer's bank\",\n        \"actions\": \"Processed\"\n    },\n    {\n        \"lineNumber\": 3,\n        \"requestType\": \"sale\",\n        \"responseType\": \"Approved\",\n        \"merchantAccountCode\": 1234567,\n        \"organizationId\": null,\n        \"gatewayTransId\": 79369804,\n        \"transactionId\": \"Line Number: 14\",\n        \"last4\": \"1111\",\n        \"transactionDate\": \"2023-11-30T00:00:00-05:00\",\n        \"amount\": 623,\n        \"tipAmount\": null,\n        \"responseCode\": \"00000\",\n        \"providerResponseMessage\": \"Successful Request\",\n        \"actions\": \"Processed\"\n    },\n    {\n        \"lineNumber\": 4,\n        \"requestType\": \"sale\",\n        \"responseType\": \"Validation Error\",\n        \"merchantAccountCode\": 1234567,\n        \"organizationId\": null,\n        \"gatewayTransId\": null,\n        \"transactionId\": \"Line Number: 15\",\n        \"last4\": \"1111\",\n        \"transactionDate\": null,\n        \"amount\": 623,\n        \"tipAmount\": null,\n        \"responseCode\": \"30029\",\n        \"providerResponseMessage\": \"Transaction Error\",\n        \"actions\": \"Resolve Errors in CSV and Reprocess Transaction\"\n    }\n]"}],"_postman_id":"f0fb7ecd-2028-46de-a852-ad447e9f20f7"},{"name":"Export Results CSV","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r","    pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Content-Type is test/csv\", function () {\r","    pm.expect(pm.response.headers.get(\"Content-Type\")).to.eql(\"text/csv\");\r","});"],"type":"text/javascript","id":"1599128c-592e-4882-a28a-1fe07635f3bf"}}],"id":"bfad4206-7ea9-4505-bcc4-8074f9710b63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/[csvId]/transactions?format=csv","description":"<p><strong>Export Results CSV</strong> will return the transaction results of a CSV <strong>id</strong> in CSV formatting.</p>\n<p>The <strong>id</strong> of the CSV should be provided in the URL as shown above with an additional query parameter of: <strong>format=csv</strong></p>\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"[username]"},{"key":"password","value":"[password]"}]},"isInherited":true,"source":{"_postman_id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","name":"Bulk Transaction API Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Bulk.Transaction.API","api","Bulk","[csvId]","transactions"],"host":["www.bridgepaynetsecuretest.com"],"query":[{"key":"format","value":"csv"}],"variable":[]}},"response":[{"id":"6dd2ff36-bb0d-4ec4-b85c-595eee47b211","name":"Export Results CSV","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/[csvId]/transactions?format=csv","protocol":"https","host":["www.bridgepaynetsecuretest.com"],"path":["Bulk.Transaction.API","api","Bulk","[csvId]","transactions"],"query":[{"key":"format","value":"csv"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"lineNumber,requestType,responseType,merchantAccountCode,organizationId,gatewayTransId,transactionId,last4,transactionDate,amount,tipAmount,responseCode,providerResponseMessage,actions\r\n2,sale,Declined,2138001,,79368704,Line Number: 2,1111,2023-11-30T00:00:00-05:00,1,,30032,Denied by customer's bank,Processed\r\n3,sale-auth,Declined,2138001,,79369004,Line Number: 3,1111,2023-11-30T00:00:00-05:00,498,,30032,Denied by customer's bank,Processed\r\n4,sale,Approved,2138001,,79368804,Line Number: 4,1111,2023-11-30T00:00:00-05:00,501,,00000,Successful Request,Processed\r\n5,sale,Declined,2138001,,79369104,Line Number: 5,1111,2023-11-30T00:00:00-05:00,7100,,30023,Invalid Account Number,Processed\r\n6,sale,Declined,2138001,,79368904,Line Number: 6,1111,2023-11-30T00:00:00-05:00,8100,,30037,Card reported lost,Processed\r\n7,sale,Declined,2138001,,79369204,Line Number: 7,1111,2023-11-30T00:00:00-05:00,9100,,30072,Call for Authorization,Processed\r\n8,sale,Declined,2138001,,79369504,Line Number: 8,1111,2023-11-30T00:00:00-05:00,10100,,30034,Hold - Pick up card,Processed\r\n9,sale,Declined,2138001,,79369404,Line Number: 9,1111,2023-11-30T00:00:00-05:00,11100,,30025,Invalid Security Code,Processed\r\n10,sale,Declined,2138001,,79369604,Line Number: 10,1111,2023-11-30T00:00:00-05:00,12100,,30033,Insufficient funds,Processed\r\n11,sale,Processing Error,2138001,,79369304,Line Number: 11,1111,2023-11-30T00:00:00-05:00,13100,,30022,Processing Network Unavailable,Processed\r\n12,sale,Processing Error,2138001,,79369704,Line Number: 12,1111,2023-11-30T00:00:00-05:00,14100,,10052,Processing Network Error,Processed\r\n13,asdf,Validation Error,2138001,,,Line Number: 13,1111,,623,,10022,Invalid Request Type,Resolve Errors in CSV and Reprocess Transaction\r\n14,sale,Approved,2138001,,79369804,Line Number: 14,1111,2023-11-30T00:00:00-05:00,623,,00000,Successful Request,Processed\r\n15,sale,Validation Error,2138001,,,Line Number: 15,1111,,623,,30029,Transaction Error,Resolve Errors in CSV and Reprocess Transaction\r\n16,sale,Validation Error,2138001,,,Line Number: 16,1234,,623,,30012,Bad Card Number,Resolve Errors in CSV and Reprocess Transaction\r\n17,sale,Validation Error,2138001,,,Line Number: 17,asdf,,623,,10002,Invalid Card Number Blank Or Null,Resolve Errors in CSV and Reprocess Transaction\r\n18,sale,Validation Error,2138001,,,Line Number: 18,,,623,,30029,Transaction Error,Resolve Errors in CSV and Reprocess Transaction\r\n19,sale,Validation Error,2138001,,,Line Number: 19,,,623,,30029,Transaction Error,Resolve Errors in CSV and Reprocess Transaction\r\n20,sale,Validation Error,2138001,,,Line Number: 20,1111,,623,,10009,Invalid Expiration Date Card Expired,Resolve Errors in CSV and Reprocess Transaction\r\n21,sale,Validation Error,2138001,,,Line Number: 21,1111,,623,,10010,Invalid Security Code Not Numeric,Resolve Errors in CSV and Reprocess Transaction\r\n22,sale,Validation Error,2138001,,,Line Number: 22,1111,,,,10028,Invalid Amount Non Numeric,Resolve Errors in CSV and Reprocess Transaction\r\n23,sale,Validation Error,2138001,,,Line Number: 23,1111,,623,,30010,Invalid Record Format,Resolve Errors in CSV and Reprocess Transaction"}],"_postman_id":"bfad4206-7ea9-4505-bcc4-8074f9710b63"},{"name":"Search CSV","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r","    pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Length is at least 1\", function () {\r","    var jsonData = pm.response.json();\r","    pm.expect(jsonData.records.length).to.be.at.least(1);\r","});"],"type":"text/javascript","id":"cd4c9ffd-c301-41d2-b74d-468f363814d2"}}],"id":"f5088d92-9ec4-4086-b4c0-c7c3ebf6939f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"status\": null,\r\n    \"filename\": null,\r\n    \"receivedUtcFrom\": \"2023-11-01T15:00:00Z\",\r\n    \"receivedUtcTo\": \"2023-11-30T22:00:00Z\",\r\n    \"skip\": 0,\r\n    \"take\": 20\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/Search","description":"<p>The Search CSV request allows the user to search for previously submitted CSV files and view the current status.</p>\n<p>The file will progress through following statuses, with some being conditional on errors or outright failure to validate:</p>\n<ul>\n<li><p><strong>Accepted and queued Status</strong></p>\n<ul>\n<li>The initial response when a file is uploaded from the API.</li>\n</ul>\n</li>\n<li><p><strong>Pending Status</strong></p>\n<ul>\n<li>The import is pending processing of the imported transactions.</li>\n</ul>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": 106,\n    \"status\": \"Pending\",\n    \"filename\": \"TestImport.csv\",\n    \"responseMessage\": \"Accepted and queued\"\n}\n\n</code></pre>\n<ul>\n<li><p><strong>Started Status</strong></p>\n<ul>\n<li>The file is actively processing.</li>\n</ul>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": 123,\n    \"status\": \"Started\",\n    \"filename\": \"TestImport.csv\",\n    \"userId\": 12345,\n    \"responseMessage\": \"File Processing Started\",\n    \"receivedUtc\": \"2023-10-05T16:13:49Z\",\n    \"startedUtc\": \"2023-10-05T16:16:50Z\",\n    \"completedUtc\": null\n}\n\n</code></pre>\n<ul>\n<li><p><strong>Completed Status</strong></p>\n<ul>\n<li>The import has been successfully processed.</li>\n</ul>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": 123,\n    \"status\": \"Completed\",\n    \"filename\": \"TestImport.csv\",\n    \"userId\": 12345,\n    \"responseMessage\": \"Completed\",\n    \"receivedUtc\": \"2023-11-30T19:22:23Z\",\n    \"startedUtc\": \"2023-11-30T19:25:24Z\",\n    \"completedUtc\": \"2023-11-30T19:25:44Z\"\n}\n\n</code></pre>\n<ul>\n<li><p><strong>Completed w/ Errors Status</strong></p>\n<ul>\n<li><p>The import has been successfully processed. However, errors occurred on one or more rows.</p>\n</li>\n<li><p>Use the “Get Export Results CSV” request to review the error(s). Once resolved, resubmit these transactions as a new import.</p>\n</li>\n</ul>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": 123,\n    \"status\": \"Completed w/Errors\",\n    \"filename\": \"TestImport_CSV.csv\",\n    \"userId\": 12345,\n    \"responseMessage\": \"Completed with Errors. Check the Export Results\",\n    \"receivedUtc\": \"2023-10-02T19:19:38Z\",\n    \"startedUtc\": \"2023-10-02T19:20:23Z\",\n    \"completedUtc\": \"2023-10-02T19:20:25Z\"\n}\n\n</code></pre>\n<ul>\n<li><strong>Failed Status</strong><ul>\n<li>Some part of the imported information did not match the format in our Mandatory Optional Fields Guide. Use the “Get Import Information” request to review the “<code>responseMessage</code>\" field error(s) and make edits to your file to import again.</li>\n</ul>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": 123,\n    \"status\": \"Failed\",\n    \"filename\": \"TestImport_CSV.csv\",\n    \"userId\": 12345,\n    \"responseMessage\": \"Errors while processing file\",\n    \"receivedUtc\": \"2023-10-02T20:54:12Z\",\n    \"startedUtc\": \"2023-10-02T20:55:29Z\",\n    \"completedUtc\": \"2023-10-02T20:56:31Z\"\n}\n\n</code></pre>\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"[username]"},{"key":"password","value":"[password]"}]},"isInherited":true,"source":{"_postman_id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","name":"Bulk Transaction API Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["Bulk.Transaction.API","api","Bulk","Search"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"a32b7ebf-8139-4b0d-bf3d-50bdeca2d6e4","name":"Search CSV","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"status\": null,\r\n    \"filename\": null,\r\n    \"receivedUtcFrom\": \"2023-09-07T15:00:00Z\",\r\n    \"receivedUtcTo\": \"2023-09-07T22:00:00Z\",\r\n    \"skip\": 0,\r\n    \"take\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk/Search"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"recordCount\": 2,\n    \"records\": [\n        {\n            \"id\": 103,\n            \"status\": \"Completed\",\n            \"filename\": \"TestImport_CSV_2.csv\",\n            \"userId\": 97187,\n            \"responseMessage\": \"Completed\",\n            \"receivedUtc\": \"2023-09-07T15:44:09Z\",\n            \"startedUtc\": \"2023-09-07T15:45:42Z\",\n            \"completedUtc\": \"2023-09-07T15:45:53Z\"\n        },\n        {\n            \"id\": 104,\n            \"status\": \"Completed\",\n            \"filename\": \"TestImport_CSV_1.csv\",\n            \"userId\": 97187,\n            \"responseMessage\": \"Completed\",\n            \"receivedUtc\": \"2023-09-07T15:49:59Z\",\n            \"startedUtc\": \"2023-09-07T15:50:26Z\",\n            \"completedUtc\": \"2023-09-07T15:50:27Z\"\n        }\n    ]\n}"}],"_postman_id":"f5088d92-9ec4-4086-b4c0-c7c3ebf6939f"}],"id":"94ed796f-e119-4932-9117-a37a0af8fffc","description":"<p>This section will outline the request types supported by the Bulk Transaction API.</p>\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9b6b5e18-1327-481e-9f79-2f609acb3eab"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6eaf9166-04f7-4d3e-8679-218d4313bba4"}}],"_postman_id":"94ed796f-e119-4932-9117-a37a0af8fffc","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"[username]"},{"key":"password","value":"[password]"}]},"isInherited":true,"source":{"_postman_id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","id":"532ab49e-44f0-4aa5-b8d9-57f254d349fe","name":"Bulk Transaction API Guide","type":"collection"}}},{"name":"Appendix","item":[],"id":"865256d9-ab15-4527-9854-6fa4dc83db5b","description":"<h4 id=\"import-transaction-guidelines\">Import Transaction Guidelines</h4>\n<p><a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/246448178/Import+Transaction+Guidelines\">Import Transaction Guidelines</a></p>\n<h4 id=\"test-credit-card-numbers\">Test Credit Card Numbers</h4>\n<p><a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/243597743/Test+Credit+Card+and+ACH+Account+Numbers\">Test Credit Card Numbers</a></p>\n<h4 id=\"test-dollar-amount-ranges\">Test Dollar Amount Ranges</h4>\n<p><a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/243663130/Test+Dollar+Amount+Ranges\">Test Dollar Amount Ranges</a></p>\n<h4 id=\"avs-and-cvv-information\">AVS and CVV Information</h4>\n<p><a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/246579219/Handling+of+CVV+and+AVS+Responses\">Handling of CVV and AVS responses</a></p>\n<h4 id=\"certification-script\">Certification Script</h4>\n<p><a href=\"https://bridgepaynetwork.atlassian.net/wiki/spaces/DC/pages/200081423/Testing+Certification\">BridgePay Gateway Certification Script</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Legend</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>R = Required</td>\n</tr>\n<tr>\n<td>O = Optional</td>\n</tr>\n<tr>\n<td>C = Conditional</td>\n</tr>\n<tr>\n<td>1 = Required if not sending Track Data</td>\n</tr>\n<tr>\n<td>3 = ACH/Checks</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"document-version\">Document Version:</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Version:</strong></th>\n<th><strong>Updated by:</strong></th>\n<th><strong>Change(s):</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1.0.0</td>\n<td>Mark Mauer</td>\n<td>Creation of the full API documentation.</td>\n</tr>\n<tr>\n<td>1.0.1</td>\n<td>Noah Hippensteel</td>\n<td>Added descriptive text for all sections.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"49024e17-c7fa-41f0-bfca-48fc7c854664"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3d25cdcd-e929-4864-8631-3674e129764b"}}],"_postman_id":"865256d9-ab15-4527-9854-6fa4dc83db5b"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"[username]"},{"key":"password","value":"[password]"}]}},"event":[{"listen":"prerequest","script":{"id":"ba83f0bd-2729-42e6-9060-04904c629202","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8cf1bd93-224b-4540-abb4-e5f854f5df4b","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"www.bridgepaynetsecuretest.com","type":"string"},{"key":"merchantCode","value":"[merchantCode]","type":"string"},{"key":"merchantAccountCode","value":"[merchantAccountCode]","type":"string"},{"key":"username","value":"[username]","type":"string"},{"key":"password","value":"[password]","type":"string"},{"key":"csvId","value":"[csvId]","type":"string"}]}