Partner Integration - CSV/TSV Export
Below you will find information on how you can download a file containing your transaction records from a specific date/time forward.
Considerations for Use
- You must ensure that you do not allow duplicate transations to post. The transaction.id field is unique and should be used to enforce this check.
- For any voids and chargebacks (ACH Rejects), the “Original” transaction is sent the line above/before the void/chargeback.
- Ensure you have proper handling of voids, we will ALWAYS send the original transaction (again if already sent) to simplify your logic handling of these transactions. The idea here was that your system would not have to account for a situation where a check would need to be done to check for voids.
- ACH Rejects will also have the original transaction sent for the sake of ensuring the original transaction was posted so there is not a case where a reversal is posted without the original sale.
- “cb” is appended to the transaction.id.
- Description is prefixed with “ACH Reject-”
Request Example
GET /v2/transactions?developer-id={developer_id}&user-id={user-id}&user-api-key={user-api-key}&location_id={location_id}&create_ts_from={from_date}&created_ts_to={from_date}&_format={csv or tsv}
Note:
- from_date
- should be based on user's local time
- should be the most recent date/time of the last transaction that was imported. This is important to ensure no transactions are skipped.
- formatted like "yyyy-mm-dd hh:mm:ss"
- should be urlencoded
TSV File Columns
| Column | Descriptions |
|---|---|
| id | A unique identifer for a transaction. |
| payment method | 'cc' or 'ach' |
| account vault id | Identifier for the stored payment account in the vault. |
| recurring id | Unique identifier for a recurring payment |
| first six | First 6 of the Account |
| last four | Last 4 of the Account |
| account holder name | For CC, this is the "Name (as it appears) on Card". For ACH, this is the "Name on Account". |
| transaction amount | Amount of the transaction. This should always be the desired settle amount of the transaction. |
| description | Text description or memo associated with the transaction. |
| transaction code | |
| avs | Address Verification System response code. |
| batch | |
| order num | Order number associated with the transaction. |
| verbiage | Verbiage to expand upon Reason Codes |
| transaction settlement status | Status indicating if the transaction has settled. |
| effective date | Date the transaction is effective or posted. |
| routing | Bank routing number for ACH transactions. |
| return date | Return Date |
| created ts | Timestamp when the transaction was created. |
| modified ts | Timestamp when the transaction was last modified. |
| transaction api id | Unique identifier for the transaction that is provided by your solution |
| terms agree | Indicates if the user agreed to terms (true/false). |
| notification email address | Email address to send transaction notifications. |
| notification email sent | Indicates if notification email was sent (true/false). |
| response message | Message returned from the payment gateway. |
| auth amount | Amount authorized for the transaction. |
| auth code | 6 character authorization code |
| status id | Status ID - See Status ID section for more detail |
| type id | Type ID - See type id section for more detail |
| location id | Identifier for the location where the transaction occurred. |
| reason code id | Response reason code that provides more detail as to the result of the transaction. The reason code list can be found here: Response Reason Codes |
| contact id | Identifier for the customer contact. |
| billing zip | Billing ZIP/postal code of the customer. |
| billing street | Billing street address of the customer. |
| product transaction id | This is equivelant to a merchant account (Deposit account) |
| tax | Amount of Sales tax |
| customer ip | IP address of the customer initiating the transaction. |
| customer id | Can be used by Merchants to identify Contacts in our system by an ID from another system. |
| po number | Purchase order number associated with the transaction. |
| avs enhanced | |
| cvv response | Response code for CVV verification. |
| billing phone | Billing phone number of the customer. |
| billing city | Billing city of the customer. |
| billing state | Billing state or province of the customer. |
| clerk number | Clerk or Employee Identifier |
| tip amount | Tip amount included in the transaction. |
| bill payment | Indicates if the transaction is a bill payment. |
| created user id | User ID of the person who created the transaction. |
| modified user id | User ID of the person who last modified the transaction. |
| ach identifier | Required for ACH transactions in certain scenarios |
| check number | Check number used in the transaction. |
| recaptcha score | Score from reCAPTCHA validation. |
| previous transaction id | previous_transaction_id is used as token to run transaction. |
| auth surcharge rate | |
| is surcharge | Indicates if a surcharge was applied (true/false). |
| auth surcharge fee | |
| subtotal amount | Subtotal amount before taxes and fees. |
| settle date | Date the transaction was settled. |
| charge back date | Date the transaction was charged back. |
| void date | Date the transaction was voided. |
| account type | For ACH, allowed values are “checking” or “savings”. For CC, this field is read only. The system will identify card type and generate a value for this field automatically. possible values are: visa, mc, disc, amex, jcb, diners, and debit. |
| is recurring | Indicates if the transaction is part of a recurring series. |
| is accountvault | Indicates if the account is stored in the vault. |
| transaction c1 | Custom field 1 for transaction |
| transaction c2 | Custom field 2 for transaction |
| transaction c3 | Custom field 3 for transaction |
| online payment cryptogram | Cryptographic data for online payment authentication. |
| ecommerce indicator | Indicator for e-commerce transaction type. |
| digital payment cryptogram | Cryptographic data for digital wallet payments. |
| terminal serial number | If transaction was processed using a terminal, this field would contain the terminal's serial number |
| entry mode id | Details how the account number was acquired |
| terminal id | The id of the terminal that will process the transaction. |
| quick invoice id | Identifier for the quick invoice associated with the transaction. |
| ach sec code | Standard Entry Class code for ACH transactions. |
| custom data | Custom data field for additional transaction information. |
| hosted payment page id | Identifier for the hosted payment page used. |
| trx source id | Identifier for the source of the transaction. |
| transaction batch id | Identifier for the batch containing the transaction. |
| recurring flag | Will be either 1 (true) or 0 (false) |
| recurring number | |
| installment number | Current installment number in a payment plan. |
| installment total count | Total number of installments in the payment plan. |
| external recurring flag | |
| external installment number | |
| external installment total count | |
| external recurring number | |
| tlid | |
| checkin date | Date of customer check-in (for lodging transactions). |
| checkout date | Date of customer check-out (for lodging transactions). |
| room num | Room number associated with the lodging transaction. |
| room rate | Rate charged for the room. |
| advance deposit | Deposit amount paid in advance. (for lodging transactions). |
| no show | Indicates if the customer was a no-show. |
| emv receipt data | EMV receipt data from chip card transaction. |