Transaction Common Terms and Variables

General Variables:

1. accountNumber: A string that represents the account number in numeral format.

2. addenda: Additional string data related to the transaction.

3. amount: The amount to be transacted; must be greater than 0 and can use decimal points with xx.xx as the required format.

4. beginDate: The starting date of the period for which transactions are sought.

5. counterpartyId: The ID of the counterparty involved in the transaction in numeral format.

6. description: A string description of the transaction.

7. direction: Indicates whether the transaction is a credit or debit. Only options are CREDIT or DEBIT.

8. endDate: The ending date of the period for which transactions are sought.

9. externalId: An external string ID that can be passed in to identify the transaction.

10. inbound: Indicates whether the ACH transaction is inbound (true) or outbound (false).

11. linkedPaymentId: The ID of the linked payment. E.g. a returned ACH transaction is linked to the origin transaction. A fee transaction is linked to the transaction that triggered the fee.

12. paymentId: The ID of the payment.

13. productId: The ID associated with the product.

14. searchKeyWords: The keywords to be used to filter the list, based on ProductID, businessID, individualID or counterpartyID.

15. secCode: The Standard Entry Class (SEC) code for ACH transactions.

16. service: The options for service level of the transaction are STANDARD and SAME_DAY.

17. status: The status of the transaction. Options include: MANUAL_REVIEW, CONTESTED, DISHONERED, ERROR, CANCELED, INITIATED, RETURNED, SENT, SUBMITTED.

18. transactionTypes: The type of the transactions.

19. updatedEnd: The end date/time for the search in ISO 8601 format (e.g., “2022-09-30T19:35:01.058Z”).

20. updatedStart: The start date/time for the search in ISO 8601 format (e.g., “2022-09-01T19:35:01.058Z”).

21. userDetails: Details of the user for which the counterparty list needs to be fetched. It should be in the JSON format.

Detailed Definitions:

SecCodes

SecCode represents the Standard Entry Class code for ACH transactions.

Here are all the SecCodes:

1. 'TEL': Telephone-Initiated Entry
2. 'CCD': Corporate Credit or Debit
3. 'CIE': Customer Initiated Entries
4. 'PPD': Prearranged Payment and Deposit Entry
5. 'WEB': Internet-Initiated/Mobile Entries

Decline Options

In the event of a transaction being declined, the following codes can be returned:

1. ACCOUNT_NOT_FOUND: No Account Found
2. CUSTOMER_NOT_FOUND: No Customer Found
3. CUSTOMER_NOT_UNIQUE: Unique Customer Not Found
4. PRODUCT_NOT_FOUND: Product Not Found
5. REJECTED_CUSTOMER_STATE: This is part of the DataValidationException.class or EntityNotFoundException.class

Transaction Types

The variable transactionTypes represents the type of the transactions.

To see the list of transactionTypes, use endpoint GET transaction/transactionTypes.

Status Options

The variable status represents the status of the transaction.

Here are all the possible status:

1. INITIATED: The transaction initiation process has begun.

2. MANUAL_REVIEW: The transaction is under manual review.

3. SUBMITTED: The transaction has been submitted for processing.

4. SENT: The transaction was sent successfully.

5. CONTESTED: The transaction has been contested by one of the parties.

6. DISHONERED: The transaction has been dishonored.

7. REJECTED: The transaction has been rejected due to various reasons.

8. CANCELED: The transaction has been canceled.

9. RETURNED: The ACH transaction was returned.

10. PENDING: The transaction is still pending approval or completion.

11. POSTED: The transaction has been posted to the account.