Log In / Register

Listing Transfers

Information about current and previous transfers are available via Apiture’s APIs. A customer can check on the current status of a transfer, or review their transfer history. Transfers can be retrieved individually, or retrieved as a list that can be filtered by certain properties.

List Multiple Transfers

The listTransfers operation returns a list of transfers the customer is entitled to view.

Transfers that were not or are not yet credited to or debited from the customer’s accounts are not listed by this operation.

To use the listTransfers operation, perform GET request against:

GET /banking/transfers

Filter query parameters can be used to reduce the number of transfers returned. Transfers can be filtered by date using a dateRange filter for the scheduledOn, creditsOn and debitsOn dates. The listTransfers function also has the historical filter query parameter that will only return completed transfers if set to true.

For more information on transfer filtering, see the API documentation and the documentation on how to use filtering.

The response includes a list of transfers formatted like the example in Get One Transfer. Due to the potential length of the list, results will be returned with Pagination. For more details on using Pagination, see this article.

Below is an example of a list of transfers:

				
					{
  "items": [
    {
      "amount": "275.00",
      "sourceAccount": {
        "id": "bd9b7af2-6f9b",
        "label": "Premiere Checking *6789",
        "type": "checking",
        "location": "internal"
      },
      "targetAccount": {
        "id": "88b1ca3e-d0f3",
        "label": "Personal Savings *4567",
        "type": "savings",
        "location": "internal"
      },
      "schedule": {
        "scheduledOn": "2026-06-28",
        "frequency": "once",
        "creditsOn": "2026-06-26",
        "debitsOn": "2026-06-24"
      },
      "processedAt": "2026-06-26T021:00:00.000Z",
      "updatedBy": "James Bond",
      "id": "0399abed-fd3d",
      "memo": "Cover check for car repair"
    }
  ]
}

Get One Transfer

The getTransfer operation returns one specific transaction. A transferId is required to do this operation. The transferId can be retrieved from the listTransfers function by using the transfer’s id property.

Perform a GET request that includes the transfer ID:

GET banking/transfers/{transferId}

An example response for one transfer is given below:

				
					{
  "amount": "275.00",
  "sourceAccount": {
    "id": "bd9b7af2-6f9b",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "targetAccount": {
    "id": "88b1ca3e-d0f3",
    "label": "Personal Savings *4567",
    "type": "savings",
    "location": "internal"
  },
  "schedule": {
    "scheduledOn": "2026-06-28",
    "frequency": "once",
    "creditsOn": "2026-06-26",
    "debitsOn": "2026-06-24"
  },
  "processedAt": "2026-06-26T021:00:00.000Z",
  "updatedBy": "James Bond",
  "id": "0399abed-fd3d",
  "memo": "Cover check for car repair"
}
On this page