Transactions Batch CSV
It is also possible to create transactions by uploading it using a CSV file. The template CSV file can be found in the portal.
To be able to upload, first you need to validate the file, second upload and create transactions.
info
Uploading a Batch CSV is only available right now for transaction method: EFT
Validating transactions from batch file#
Use this endpoint if you want to validate a transactions batch file.
Method: POST
Endpoint: {{env}}/api/transaction/ValidateBatchFile
- Payload
- Response
Input parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| TransactionType | string | yes | Transaction type |
| WalletId | string | no | The Wallet Id, according to TransactionType |
| FundingSourceId | string | no | The Funding Source Id |
| Bytes | string | yes | The file's blob |
- Concerning
FundingSourceIdandWalletId, just one of them must be sent
Response
| Parameter | Type | Description |
|---|---|---|
| InvalidTransactions | string | The amount of invalid transactions |
| ValidTransactions | int | The amount of valid transactions |
| Status | string | The validation status |
| TotalAmount | decimal | The sum of all transactions amount |
| Transactions | ||
| AccountNumber | string | The account number |
| Amount | decimal | The transaction's amount |
| Comment | string | The transaction's comment |
| CompanyName | string | Company's name |
| CustomerId | string | Customer id |
| FirstName | string | User's first name |
| LastName | string | User's last name |
| InstitutionNumber | string | Institution's number |
| Memo | string | The transaction's memo |
| Status | string | The status |
| TransitNumber | string | Transit number |
Each transaction will return a Status property explaining what is wrong with it
Status
| Description |
|---|
| Ok |
| First Name, Last Name or Company name are mandatory |
| Either First and Last Name or Company Name should be informed |
| Institution, Transit and Account numbers are mandatory |
| Institution Number min length is 3 characters |
| Transit Number length needs to be 5 characters |
| Account Number min length is 5 characters |
| Account Number max length is 12 characters |
| Invalid amount |
| Amount must be greater than zero |
| Duplicated transaction |
Creating transactions through batch file#
Use this endpoint if you want to create transactions using a batch file.
Method: POST
Endpoint: {{env}}/api/transaction/ProcessBatchFile
- Payload
- Response
Input parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| TransactionType | string | yes | Transaction type |
| WalletId | string | no | The Wallet Id, according to TransactionType |
| FundingSourceId | string | no | The Funding Source Id |
| Bytes | string | yes | The file's blob |
| WithdrawSumTotalFromFundingSource | bool | no | If set to True, we will do one transaction to pull the entire sum of transactions in the batch from the funding source. This is only applicable for Accounts Payable transactions with more than 1 transaction in the file. It does not work for scheduled transactions. Read more about this feature here. |
- Concerning
FundingSourceIdandWalletId, just one of them must be sent
TransactionType
| Type | Description |
|---|---|
| AccountsReceivable | Execute accounts receivable AR |
| AccountsPayable | Execute accounts payable AP |