Public
Documentation Settings
No Environment
Single Column
cURL - cURL
Bulk Transaction API Guide
Introduction
Overview
Integration Support
Request & Response Information
Specific Request Layouts
Appendix

Bulk Transaction API Guide

AUTHORIZATIONBasic Auth
Username

[username]

Password

[password]

Overview

Introduction

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.

Connection Strings

The following endpoint will be the basis for all endpoints used by the API:

https://www.bridgepaynetsecuretest.com/Bulk.Transaction.API/api/Bulk

Key Elements

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 id value to use in future requests to get the status of the CSV file import.

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 Search CSV function.

BridgePay recommends enabling duplicate checking on any Merchant Accounts intending to use the import transaction function to avoid transaction duplication from duplicated import files.

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.

Process Flow

The import process involves 3 steps:

  • Create the Import File

    • The file must be saved in a CSV format. Download the Sample_Import_CSV_v1.csv.
    • The format must follow the BridgePay Mandatory and Optional Fields Guide. Download the Import Transactions - Mandatory and Optional Fields Guide v1.0.xlsx.
    • Sample files above may be found here.

  • Upload the File

    • Select your CSV file that is under 5MB.
    • Once chosen, import your CSV file.
    • The imported CSV file will be validated immediately, and transactions will process every five minutes.

  • File Validation and Processing

    • BridgePay will validate your file to ensure that it is formatted correctly.
    • If successful:
      • BridgePay Processes the provided transactions
      • Results may be accessed via the Export Results JSON/CSV
    • If unsuccessful:
      • Any validation errors will be updated to the id record. Use the Export or Search functions to view updates to an id.

Authentication Information

Each call to the API requires credentials for use with Basic Authorization via HTTPS. These credentials will include a username and password with appropriate permissions for processing transactions on the intended merchant account.