Get Scheduled Transfers List
This endpoint retrieves a list of all scheduled transfers associated with the authenticated user. The response includes details of each scheduled transfer, such as the transfer amount, frequency, scheduled dates, and the accounts involved. Both active and inactive scheduled transfers can be retrieved by using the optional query parameter.
Endpoint
GET /api/scheduledTransfer
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2
Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint to display a customer's scheduled transfer history and upcoming scheduled transfers in a dashboard or account management interface. It is also useful for auditing recurring transfer configurations, verifying that scheduled transfers are active, and checking when the next transfer execution will occur.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| includeInactive | boolean | No | When true, returns both active and inactive scheduled transfers. Defaults to false (active only). |
Response
200 OK
Returns an array of scheduled transfer objects.
| Field | Type | Description |
|---|---|---|
| id | integer (int32) | Unique identifier for the scheduled transfer. |
| name | string | Optional label or name assigned to the scheduled transfer. |
| fromFinancialAccountId | string | Identifier of the source financial account. |
| toFinancialAccountId | string | Identifier of the destination financial account. |
| isActive | boolean | Indicates whether the scheduled transfer is currently active. |
| transferType | string (enum) | Type of transfer. One of: IncommingAchTransfer, OutcommingAchTrasfer, InternalTransfer, TransferBetweenOwnAccounts, AutoPopup, AutoPopupFromOwnAccount, Fee. |
| amount | integer (int64) | Transfer amount in the smallest currency unit (e.g., cents for USD). |
| currencyCode | integer (int32) | ISO 4217 numeric currency code. Currently supported: 840 (USD). |
| frequency | string | Recurrence frequency of the scheduled transfer (e.g., Weekly, Monthly). |
| lastDate | string (date-time) | Date and time the transfer last executed. Null if it has not yet run. |
| nextDate | string (date-time) | Date and time the transfer is next scheduled to execute. |
| endDate | string (date-time) | Date and time after which no further executions will occur. Null if no end date is set. |
| memo | string | Optional memo or note associated with the transfer. |
| minAmount | integer (int64) | Minimum balance threshold that must be met before the transfer executes. Null if no minimum is set. |
| isRejected | boolean | Indicates whether the most recent execution attempt was rejected. |
[
{
"id": 1042,
"name": "Monthly Savings Transfer",
"fromFinancialAccountId": "XXXXXXXXXX",
"toFinancialAccountId": "XXXXXXXXXX",
"isActive": true,
"transferType": "TransferBetweenOwnAccounts",
"amount": 50000,
"currencyCode": 840,
"frequency": "Monthly",
"lastDate": "2026-05-01T09:00:00Z",
"nextDate": "2026-06-01T09:00:00Z",
"endDate": "2027-01-01T09:00:00Z",
"memo": "Automated savings",
"minAmount": null,
"isRejected": false
},
{
"id": 1043,
"name": "Payee ACH Payment",
"fromFinancialAccountId": "XXXXXXXXXX",
"toFinancialAccountId": "XXXXXXXXXX",
"isActive": false,
"transferType": "OutcommingAchTrasfer",
"amount": 120000,
"currencyCode": 840,
"frequency": "Weekly",
"lastDate": "2026-03-15T08:00:00Z",
"nextDate": null,
"endDate": "2026-03-15T08:00:00Z",
"memo": "Vendor payment",
"minAmount": 10000,
"isRejected": false
}
]Error Codes
| Code | When it happens |
|---|---|
| 400 | Invalid query parameters (e.g., non-boolean value for includeInactive). |
| 401 | Token missing, expired, or invalid. |
| 403 | Insufficient permissions to access scheduled transfers. |
| 404 | No scheduled transfers resource found for the user. |
| 500 | Internal server error while processing the request. |
Common Mistakes
- Passing
includeInactive=1orincludeInactive=yesinstead of a proper boolean (true/false) will result in a 400 error. - The
amountandminAmountfields are in the smallest currency unit (cents). A value of50000represents $500.00 USD, not $50,000. - Not providing the
includeInactive=trueparameter and then wondering why previously cancelled or deactivated scheduled transfers are missing from the response. - Expecting pagination parameters (
page,limit) — this endpoint returns all matching records in a single array response; client-side pagination must be handled by the integrator. - The
transferTypeenum values contain typos that are intentional (OutcommingAchTrasfer,IncommingAchTransfer) — use these exact strings when filtering client-side.
Related Endpoints
POST /api/scheduledTransfer— Create a new scheduled transferPUT /api/scheduledTransfer/{id}— Update an existing scheduled transferDELETE /api/scheduledTransfer/{id}— Delete or deactivate a scheduled transferGET /api/transfer— Retrieve completed (executed) transfer history
Example
curl -X GET "https://api.banking.netevia.dev/api/scheduledTransfer?includeInactive=false" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"