Retrieving Business Transfer Information
Business transfers are used to process a batch of many individual payment instructions (or collections) at the same time. For more information on business transfers and any related terminology, see our Business Transfers conceptual article.
The BusinessTransfersAdminstration API is a read-only API that is used to view ACH business transfers and their related payment instructions. This document covers how to use these operations.
Business transfers cannot be created or otherwise modified via API operations at this time.
Authentication
You must be authenticated and authorized to use any of the API functions mentioned in this article. For more information, read the Authentication and Authorization article.
Getting Business Transfers
The getBusinessTransfers operation is used to get the transfer data for one or more business transactions.
Perform the following GET request with a completed transfers query parameter:
GET https://api.apiture.com/bankingAdmin/businessTransfers?transfers=ZYX,WVU,TSR
The values of the transfers query parameter should be the businessTransferID numbers to be returned in a comma-separated list. If there is only one businessTransferID, exclude all commas. At least one businessTransferID is required.
A maximum of 100 businessTransferID s may be requested at one time.
The response data includes the data related to the business transfer. An example response can be viewed in the API documentation.
The response does not include the payment instructions for the batches. The payment instructions must be retrieved for each individual business transfer.
Getting Payment Instructions for a Business Transfer
The listBusinessTransferAchBatchInstructions operation is used to get the payment instructions for an individual payment batch.
Perform the following GET request with a single businessTransferID in the [businessTransferID]placeholder:
GET https://api.apiture.com/bankingAdmin/businessTransfers/[businessTransferId]/achBatchInstructions
All of the payment instructions included with the individual transfer are returned in one response. An example response can be viewed in the API documentation.
Getting Account Locations and Numbers
For customers collecting event data, business transfer Event Messages do not include full account information. To retrieve full account numbers and other information for a business transfer, a separate operation must be called.
The getWireTransferAccounts operation is used to get full account numbers for both wire transfers and for business transfers.
Note: For basic ACH transfers, a dedicated API exists for getting additional information. The getWireTransferAccounts operation would not be used.
Perform the following POST request with the institution ID included in the header and a populated request body:
POST /bankingAdmin/wireTransferAccounts
The Institution-ID should be included in the request header, shown on the line 4:
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Institution-Id':'TIBURON',
'Authorization':'Bearer {access-token}'
};
The request body must contain a list of Business Transfer IDs, Wire Transfer IDs, or tracking numbers:
'{
"items": [
"12345",
"6789",
"98765",
"43210"
]
}';
Note: Although the request body is used to safely pass data, the operation is idempotent and does not edit any transfer data.
The response includes any requested account data, or a notFound parameter populated with the ID or tracking number that did not point to any account data. An example response can be found in the API documentation.