Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of transfers. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.
curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/scheduledTransfers?start=&limit=&sortBy=&filter=&q=&state=&name=&account=&sourceAccount=&targetAccount="
import { ScheduledTransferApi } from "@apiture/transfers-client-sdk";
const scheduledTransferApi = new ScheduledTransferApi(configuration);
// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
scheduledTransferApi.setAccessToken(accessToken)
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
scheduledTransferApi.setApiKey(apiKey);
var api = new Transfers.ScheduledTransferApi.getScheduledTransfers()
var opts = {
'start': 789, // {Long} The zero-based index of the first transfer item to include in this page. The default 0 denotes the beginning of the collection.
'limit': 56, // {Integer} The maximum number of transfer representations to return in this page.
'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
'state': , // {array[String]} Subset the transfers collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'name': name_example, // {String} Subset the transfers collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'account': account_example, // {String} Filter the result to transfers from or to the account named by this parameter. The value is the `_id` (not the account number) of an external or internal account. This parameter is ignored if both `?sourceAccount=` and `?targetAccount=` are supplied. For security purposes, note that this is not the same as the account number.
'sourceAccount': sourceAccount_example, // {String} Filter the result to transfers _from_ the account named by this parameter. The value is the `_id` (not the account number) of the source external or internal account. For security purposes, note that this is not the same as the account number.
'targetAccount': targetAccount_example // {String} Filter the result to transfers _to_ the account named by this parameter. The value is the `_id` (not the account number) of the target external or internal account. For security purposes, note that this is not the same as the account number.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
scheduledTransferApi.getScheduledTransfers(opts, callback);
banking/read |
Read access to accounts and account-related resources such as transfers and transactions. |
banking/write |
Write (update) access to accounts and account-related resources such as transfers and transactions. |
banking/delete |
Delete access to deletable accounts and account-related resources such as transfers. |
banking/readBalance |
Read access to account balances. This must be granted in addition to the `banking/read` scope in order to view balances, but is included in the `banking/full` scope. |
banking/full |
Full access to accounts and account-related resources such as transfers and transactions. |
admin/read |
Read access to system configuration. |
admin/write |
Write (update) access to system configuration. |
admin/full |
Full access to system configuration. |
Name |
Description |
start |
Long
(int64)
The zero-based index of the first transfer item to include in this page. The default 0 denotes the beginning of the collection.
|
limit |
Integer
(int32)
The maximum number of transfer representations to return in this page.
|
sortBy |
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
|
filter |
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
q |
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
|
state |
array[String]
Subset the transfers collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
name |
String
Subset the transfers collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is `Bartell`; `?name=Bartell|kirsten` will match items whose name is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
account |
String
Filter the result to transfers from or to the account named by this parameter. The value is the `_id` (not the account number) of an external or internal account. This parameter is ignored if both `?sourceAccount=` and `?targetAccount=` are supplied. For security purposes, note that this is not the same as the account number.
|
sourceAccount |
String
Filter the result to transfers _from_ the account named by this parameter. The value is the `_id` (not the account number) of the source external or internal account. For security purposes, note that this is not the same as the account number.
|
targetAccount |
String
Filter the result to transfers _to_ the account named by this parameter. The value is the `_id` (not the account number) of the target external or internal account. For security purposes, note that this is not the same as the account number.
|