Partners can display the latest ACH Consumer Transactions (e-checks) data by populating their UI/Portal using the Merchant Dashboard API.
You can find a brief description under the following headings:
- ACH Consumer Transaction API
- Manipulation of ACH data using the Merchant Dashboard API
Consumer Transaction Reporting link
ACH Consumer Transaction API
The Merchant Dashboard ACH Consumer Transaction API can be used to pull ACH payment data by a partner. The API includes the fields below, which assist to identify transaction and submerchant information. Additional ACH field definitions can be found in the Merchant Dashboard API documentation:
- LocationName: DBA Name
- OperationType: Type of Operation e.g. Sale or Refund
- TransactionNumber: ACH transaction number. This remains the same throughout different states of a transaction.
- ReferenceNumber: Unique Reference number identifying a transaction. A transaction number may have multiple reference numbers associated to it for each operation type (Sale,Refund).
- EventDateTime: Date and time stamp of events providing history of transactions.
- TotalAmount: Gross transaction amount
- EventDataString: Event description of a transaction. e.g. Return Reason.
- EventType: provides ACH transaction status.
Manipulation of ACH Data
The Merchant Dashboard ACH API is used to pull data for a transaction date range by partner.
The data should be pulled once per day at 11 PM EST. The transaction start date and end date (TransactionDateTime) is used to pull data with a rolling 14 calendar day. Thus, the API should be used to pull the same transaction date (TransactionDateTime) for 14 days after the date has passed.
Note the following details for using the API to manipulate ACH data:
- ACH data should be stored in a database and manipulated to obtain the latest transaction event.
- TransactionNumber can be used to filter by unique transaction. Transactions may have multiple Reference Numbers, denoting a different Operation Type (Sale, Refund).
- Each transaction should be sorted by EventDateTime to determine the latest status.
- The API should pull the same transactions using TransactionDateTime for 14 days after the date has passed.
- The latest event status of a transaction EventType, along with other ACH Consumer Transaction data, should be updated and displayed in the partner’s UI/Portal daily.