Transaction
A transaction represents a movement of funds. This includes requests via the /transfer/create route, interest paid, manual adjustments, debit card transactions, incoming ACH requests, etc.
The transaction resource is used for retrieving one or more transactions. Transactions that are initiated via the /transfer/create route with external bank accounts (or via a recurring contribution) can be voided as long as the ACH request has not yet been delivered to NACHA.
Take me to the Transaction Endpoint Reference
transaction Object
Property | Data Type (length) | Description |
---|---|---|
accountId | integer | The Helix-assigned unique ID for the account this transaction posted against |
amount | decimal | The amount of funds the transaction represents. |
availableDate | datetime | The exact date and time the funds associated with the transaction became available. Returned in time zone local to the bank. Format: yyyy-MM-ddTHH:mm:ss.SSSZ Example: 2021-07-04T15:30:45.123+05:00 |
cardId | integer | The Helix-generated unique ID for the card that created the transaction. Will be empty or 0 if this transaction is not tied to a card. |
cardMerchantInfo | object | A cardMerchantInfo object |
check | object | Check object related to check deposit transaction types. |
createdDate | datetime | The exact date and time the transaction was created. Returned in time zone local to the bank. Format: yyyy-MM-ddTHH:mm:ss.SSSZ Example: 2021-07-04T15:30:45.123+05:00 |
customerId | integer | Customer who owns the bank account associated with the transaction. |
customField1 | string | Only used internally by Q2 |
depositAvailability | object | depositAvailability object related to deposit transaction types. |
description | string | Represents a client-specified description of the transaction. - If from a Nacha file ( typeCode is UNKWTH, UNKDEP , UNKPRG ), contains description verbatim from Nacha file (must be displayed to the end user). - If from ISO-8583 interface (debit card transaction), contains description verbatim from DataElement 43 (Card Acceptor Name/Location) plus any fees/surcharges (must be displayed to the end user). - Otherwise, contains description passed by the client code. |
feeCode | enum | The code of the fee this transaction represents. Possible values: - ACH : Same Day ACH Fee - DAF : Dormancy Fee - IAF : Inactivity Fee - ICF : International Card Fee - NSF : Insufficient Funds Fee - RGD : Regulation D Fee - RTN : Return Item Fee |
feeDescription | enum | The description of the fee this transaction represents. See feeCode for possible values. |
friendlyDescription | string | A human-readable description of the transaction. Automatically generated by Helix based on typeCode . |
institutionName | string | The name of the financial institution that originated the transaction. Populated when possible. |
isCredit | boolean | true if the amount is crediting the given accountId , false otherwise. |
isEarlyDirectDeposit | boolean | true if the transaction was an early direct deposit. |
isSameDaySettle | boolean | true if the transaction is Same Day ACH. |
masterId | long integer (64-bit) | The unique identifier created by Helix used to group related transactions together. Examples: ACH withdrawal + return, debit card auth + completion(s), check deposit + return. |
nachaDescription | deprecated | Deprecated. Use description instead. |
nachaInfo | object | A nachaInfo object |
purposeCode | string (10) | Identifier describing the purpose of the transaction, provided to the fraud/risk vendor. Values agreed on during onboarding. |
requestingCustomerId | integer | The individual who requested/initiated the transaction (if different from the account owner). Relevant for business accounts. |
returnCode | string | The Nacha return code representing why the transaction was returned. |
runningAccountBalance | decimal | The accountBalance of the Account this transaction posted against after settlement. |
settledDate | datetime | The exact date and time the transaction was settled. Returned in bank local time. Format: yyyy-MM-ddTHH:mm:ss.SSSZ Example: 2021-07-04T15:30:45.123+05:00 |
statementDate | datetime | Same as settledDate . |
status | enum | Valid values: - Initiated : Created but not yet in NACHA file - Pending : Created and in NACHA file - Settled : Posted to account - Voided : Transaction voided |
subType | enum | Description of subtypeCode for this transaction (card transactions only). |
subTypeCode | string (6) | Merchant Category Code. Categorizes merchants with similar lines of business (card transactions only). |
transactionTag | string (50) | Unique identifier provided by caller during /transfer/create. Helix does not generate this. |
transactionCount | integer | The total transactions that meet your query criteria. Note: only a single page is returned per call. See /transaction/list. |
transactionId | long integer (64-bit) | Helix-assigned unique ID for the transaction. |
type | string | Human-readable description of the transaction type. See Transaction Type Detail table. |
typeCode | string (6) | Programmatic code for the type of transaction. See Transaction Types. |
voidedDate | datetime | The exact date and time the transaction was voided. Returned in bank local time. |
wireInfo | object | A wireInfo object |
cardMerchantInfo Object
An object containing additional merchant data for card transactions:
Property | Data Type (length) | Description |
---|---|---|
merchantCity | string (13) | The city of the merchant at which the transaction originated. |
merchantCountryCode | string (2) | The country code of the card acceptor. |
merchantGroupcode | string (6) | A grouping of multiple Merchant Category Codes into fewer, more useful sets. |
merchantId | string (15) | The identification code of the merchant that accepted the card information. |
merchantLocation | string (23) | The location of the merchant at which the transaction originated. |
merchantStateCode | string (2) | The two-character state abbreviation of the merchant. |
merchantZipCode | string (9) | The postal code of the merchant. |
nachaInfo Object
An object containing additional ACH file data for externally-originated ACH deposits into Helix accounts:
Property | Data Type (length) | Description |
---|---|---|
companyDiscretionaryData | string | |
companyEntryDescription | string | |
companyIdentification | string | The companyIdentification field is in the Batch Header Record of an ACH File and identifies the Originator. |
companyName | string | |
isEarlyDeposit | boolean | |
nachaSettledDate | datetime | |
standardEntryClassCode | string |
wireInfo Object
An object containing additional data for wire transactions:
Property | Data Type (length) | Description |
---|---|---|
beneficiaryAccountNumberMasked | string | Masked account number at beneficiary’s financial institution. Example: **********1234 |
beneficiaryAddressLine1 | string | Address line 1 of the beneficiary. |
beneficiaryAddressLine2 | string | Address line 2 of the beneficiary. |
beneficiaryAddressLine3 | string | Address line 3 of the beneficiary. |
beneficiaryFIAddressLine1 | string | Address line 1 of beneficiary’s financial institution. |
beneficiaryFIAddressLine2 | string | Address line 2 of beneficiary’s financial institution. |
beneficiaryFIAddressLine3 | string | Address line 3 of beneficiary’s financial institution. |
beneficiaryFIName | string | Name of the beneficiary’s financial institution. |
beneficiaryFIRoutingNumber | string | Routing number of the beneficiary’s financial institution. |
beneficiaryName | string | Full name of the beneficiary. |
intermediaryFIName | string | Name of intermediary financial institution. |
intermediaryFIRoutingNumber | string | Routing number of intermediary financial institution. |
intermediaryFIAddress | string | Address of intermediary financial institution. |
intermediaryFICity | string | City of intermediary financial institution. |
intermediaryFIState | string | U.S. state abbreviation of intermediary financial institution. |
intermediaryFIPostalCode | string | Postal code of intermediary financial institution. |
originatorAddressLine1 | string | Address line 1 of the originator. |
originatorAddressLine2 | string | Address line 2 of the originator. |
originatorAddressLine3 | string | Address line 3 of the originator. |
originatorName | string | Full name of the originator (sender). |
originatorToBeneficiaryInformation | string | Provides details about the payment to the beneficiary. |
receiverRoutingNumber | string | |
receiverShortName | string | |
senderReference | string | |
senderRoutingNumber | string | Routing number of the financial institution originating the transfer. |
senderShortName | string | Shortened name of the originating financial institution. |
wireCreatedDate | datetime | |
wireId | long integer (64-bit) | |
wireType | string |
Updated 4 days ago