Guides

Common Variables and their options

Suggest Edits

The API reference page outlines the common variables used across multiple endpoints. Each variable is clearly defined to aid the users in understanding their usage. For variables that have more than one option, such as 'direction', 'secCode', 'service', 'status', and 'transactionTypes', all possible choices are thoroughly listed. This structure ensures that users have a comprehensive understanding and can accurately utilize the API to their maximum advantage.

Welcome to our comprehensive guide, providing clarity and in-depth understanding of critical parameters in our service. This documentation currently focuses on two main areas:

  1. Counterparty

    • Key variables: counterpartyId, type, businessName, firstName, lastName, email, phone
    • Detailed definitions: Counterparty Types, Bank Account Types, Account Types, Email and Phone Format

  2. Transactions

    • General variables: accountNumber, addenda, amount, beginDate, counterpartyId, description, direction, endDate, externalId, inbound, linkedPaymentId, paymentId, productId, searchKeyWords, secCode, service, status, transactionTypes, updatedEnd, updatedStart, userDetails
    • Detailed definitions: SecCodes, Decline Options, Transaction Types, Status Options

With these key insights, you'll be well-prepared to navigate smoothly and successfully within our system. Consider this guide your first point of reference for understanding and correctly utilizing the specific variables and definitions related to counterparties and transactions. More categories will be added to this documentation as we expand our service and introduce new endpoints.

Counterparty

General Variables

For counterparty, these variables are shared across multiple endpoints:

  1. counterpartyId: A unique identifier for the counterparty.
  2. type: Denotes the type of the counterparty, either BUSINESS or INDIVIDUAL.
  3. businessName: The name of the business. Required when type is BUSINESS.
  4. firstName and lastName: The first name and last name of the individual. Required when type is INDIVIDUAL.
  5. email: Email address of the counterparty. Optional.
  6. phone: Phone number of the counterparty. Optional.

Detailed Definitions

Counterparty Types

The type variable can hold one of the following:

  1. BUSINESS: This denotes that the counterparty is a business entity.
  2. INDIVIDUAL: This indicates that the counterparty is an individual person.

Bank Account Types

The bankAccountType variable can hold one of the following:

  1. SAVINGS: This indicates a saving bank account.
  2. CHECKING: This denotes a checking bank account.

Account Types

The accountType variable can take on one of the following:

  1. BUSINESS_CHECKING: This indicates that the account is a checking account held by a business.
  2. BUSINESS_SAVING: This denotes that the account is a savings account held by a business.
  3. INDIVIDUAL_CHECKING: This represents a checking account held by an individual.
  4. INDIVIDUAL_SAVING: This indicates that the account is a savings account held by an individual.

Email and Phone Format

  1. Email - The email field when provided, should follow standard email format, e.g., [email protected].
  2. Phone - The phone field, if included, should adhere to the international format, which includes the country code followed by the number, for example, +11234567890. Any number not conforming to this format might result in errors or unsuccessful responses while interfacing with this endpoint.

Transactions

General Variables:

These variables are common to both endpoints:

  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. Here are all the possible transactionTypes:

  1. ACH_DEPOSIT_STABLE

  2. ACH_TRANSFER

  3. WIRE_TRANSFER

  4. CHECK

  5. DEBIT_CARD

  6. CREDIT_CARD

  7. PAYPAL

  8. VENMO

  9. CASH_APP

  10. ZELLE

  11. CRYPTOCURRENCY

Status Options

The variable status represents the status of the transaction. Here are all the possible status:

  1. MANUAL_REVIEW: The transaction is under manual review.

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

  3. DISHONERED: The transaction has been dishonored.

  4. ERROR: There was an error processing the transaction.

  5. CANCELED: The transaction has been canceled.

  6. INITIATED: The transaction initiation process has begun.

  7. RETURNED: The transaction was returned.

  8. SENT: The transaction was sent successfully.

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

  10. IN_PROGRESS: The transaction is currently being processed.

  11. COMPLETED: The transaction was successfully completed.

  12. FAILED: The transaction failed due to one or more reasons.

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

  14. REVERSED: The transaction was reversed/canceled after being initiated.

  15. DECLINED: The transaction was declined by the receiving party or the financial institution.

Updated 2 months ago