Introduction:
This guide will help you set up and effectively utilize our new Transaction Adapter, an innovative addition to our Cash Application module. Designed to accommodate customers whose banks are not compatible with Plaid integration, the Transaction Adapter offers an alternative method for retrieving bank transaction data files. By following this comprehensive guide, you can assist your customers in seamlessly integrating this feature into their workflow, ensuring a smooth and successful experience.
Supported File Type: CSV/XSLX
The Transaction Adapter supports CSV (Comma-Separated Values) or XSLX file format, ensuring compatibility with a wide range of banking systems.
Required Files:
To upload transaction data we need to get 2 files:
Bank Accounts Details
Bank Transactions Details
For each file, we have listed in a table the fields that can be included in the file. Each row represents a field and includes the following information:
Name: The name of the field.
Type: The data type of the field, such as
string,boolean, ordate.Required: Whether the field is required or optional.
Value example: An example of a valid value for the field.
Description: A brief description of the field and its purpose.
Bank Account Data Fields and Types
Name | Type | Required? | Value example | Description |
Id | string | Yes | "ab1ffc96-de3e-4e2d-a7a0-642e2b22b560" | This is a unique number per bank account (account ID). There are no duplicate values through the file. |
accountNumber | string | Yes | "111111" |
|
bankName | string | Yes | "Bank of America" |
|
Bank Transaction Data Fields and Types
Name | Type | Required? | Value example | Description |
accountId | string | Yes | "ab1ffc96-de3e-4e2d-a7a0-642e2b22b560" | The same Account ID provided in the Bank Account Details file |
id | string | Yes | "60068fc8-b3a6-4549-9514-49f8fc466a52" | This is the transaction Id OR the bank reference number. |
description | string | Yes | "BLUESNAP INC. 1260534 CCD 2303759" | Bank transaction description |
amount | number | Yes | "3669" | Positive number for credit amount, negative number for debit amount |
currency | string | Yes | "USD" |
|
date | datetime | Yes | "2012-04-23"
OR
"2012-04-23T18:25:43.511Z" |
|
Guiding Customers:
Bank Account Details file:
Instruct customers to obtain a CSV or XSLX file containing their bank account details, including Account ID, Bank Name, and Account Number.
Ensure that the Account ID provided in this file matches the Account ID used in the Bank Transaction Details file.
Bank Transaction Details :
Advise customers to retrieve a CSV or XSLX file containing their bank transaction details, including Account ID (matching the one from the Bank Account Details CSV), Transaction ID, Description, Amount, Currency, and Transaction Date.