Transfers

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API.


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/"
import { APIApi } from "@apiture/transfers-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Transfers.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/apiDoc"
import { APIApi } from "@apiture/transfers-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Transfers.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


Configuration

getConfiguration

Configuration definition for this API

Returns the configuration for this API


/configurations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/configurations"
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.getConfiguration()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfiguration(callback);

Scopes

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.

Parameters

Responses


getConfigurationGroup

Fetch a representation of this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group resource.


/configurations/groups/{groupName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/configurations/groups/{groupName}"
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.getConfigurationGroup()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroup(groupName, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-None-Match` request header for *`GET`* operations for this configuration group resource.


getConfigurationGroupSchema

Fetch the schema for this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group schema resource.


/configurations/groups/{groupName}/schema

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/configurations/groups/{groupName}/schema"
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.getConfigurationGroupSchema()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupSchema(groupName, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroupValue

Fetch a single value associated with the specified configuration group

Fetch a single value associated with this configuration group. This provides convenient access to the individual values` of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To update a specific value, use `PUT /transfers/configurations/groups/{groupName}/values/{valueName}` (operation `updateConfigurationGroupValue`).


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.getConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValue(groupName, valueName, callback);

Scopes

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.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


getConfigurationGroupValues

Fetch the values for the specified configuration group

Return a representation of this configuration group values resource.


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.getConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValues(groupName, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroups

Return a collection of configuration groups

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 configuration groups. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/configurations/groups

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/configurations/groups?start=&limit=&sortBy=&filter=&q="
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.getConfigurationGroups()
var opts = {
  'start': 789, // {Long} The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of configuration group 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).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroups(opts, callback);

Scopes

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.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of configuration group 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).

Responses


updateConfigurationGroupValue

Update a single value associated with the specified configuration group

Update a single value associated with this configuration group. This provides convenient access to individual `values` of the configuration group as defined in the configuration group's `schema`. The request body must conform to the configuration group's schema for the named `{valueName}`. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To fetch specific value, use `GET /transfers/configurations/groups/{groupName}/values/{valueName}` (operation `getConfigurationGroupValue`). This operation is reserved for administrators.


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///transfers/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.updateConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
var body = body_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValue(groupName, valueName, body, callback);

Scopes

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.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required
Body parameters
Name Description
body *

The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


updateConfigurationGroupValues

Update the values for the specified configuration group

Perform a complete replacement of this set of values. This operation is reserved for administrators.


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///transfers/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/transfers-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Transfers.ConfigurationApi.updateConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var requestBody = ; // {map[String, configurationValue]} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValues(groupName, requestBody, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
requestBody *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`*


PastTransfer

getPastTransfer

Fetch a representation of this past transfer

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this transfer resource.


/pastTransfers/{pastTransferId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/pastTransfers/{pastTransferId}?unmasked="
import { PastTransferApi } from "@apiture/transfers-client-sdk";

const pastTransferApi = new PastTransferApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
pastTransferApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
pastTransferApi.setApiKey(apiKey);


var api = new Transfers.PastTransferApi.getPastTransfer()
var pastTransferId = pastTransferId_example; // {String} The unique identifier of this scheduled transfer. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example, // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
  'unmasked': true // {Boolean} When requesting a transfer, the full account number of the source and target accounts is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
pastTransferApi.getPastTransfer(pastTransferId, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
pastTransferId*
String
The unique identifier of this scheduled transfer. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
Query parameters
Name Description
unmasked
Boolean
When requesting a transfer, the full account number of the source and target accounts is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this transfer resource.


getPastTransfers

Return a collection of past transfers

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 past transfers. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. Past transfers are transfers which have been processed or canceled.


/pastTransfers

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/pastTransfers?start=&limit=&sortBy=&filter=&q=&state=&name=&account=&sourceAccount=&targetAccount="
import { PastTransferApi } from "@apiture/transfers-client-sdk";

const pastTransferApi = new PastTransferApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
pastTransferApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
pastTransferApi.setApiKey(apiKey);


var api = new Transfers.PastTransferApi.getPastTransfers()
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);
  }
};
pastTransferApi.getPastTransfers(opts, callback);

Scopes

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.

Parameters

Query parameters
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.

Responses


ScheduledTransfer

cancelScheduledTransfer

Cancel a scheduled transfer

`POST` the URI of a scheduled transfer to cancel it. This cancels all future recurring transfers. Any transfers that would have occurred on future dates will be canceled. This operation is only valid on scheduled transfers which are in the `scheduled`, `recurring`, or `suspended` state. It may also be allowed if the transfer state is `processing` and the optional cutoff time has not passed. This operation is invoked by submitting a `POST` to the `href` in the scheduled transfer's *`apiture:cancel`* link, The link will be present if the transfer can be canceled.


/canceledScheduledTransfers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///transfers/canceledScheduledTransfers?scheduledTransfer=&scheduledTransferUri="
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.cancelScheduledTransfer()
var scheduledTransfer = scheduledTransfer_example; // {String} A server-generated key which identifies a scheduled transfer resource.
var opts = {
  'scheduledTransferUri': scheduledTransferUri_example, // {String} The URI of a scheduled transfer resource. This parameter is **deprecated** and will be removed in the next version. Use `?scheduledTransfer=` instead.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
scheduledTransferApi.cancelScheduledTransfer(scheduledTransfer, opts, callback);

Scopes

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.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
scheduledTransfer*
String
A server-generated key which identifies a scheduled transfer resource.
Required
scheduledTransferUri
String
The URI of a scheduled transfer resource. This parameter is **deprecated** and will be removed in the next version. Use `?scheduledTransfer=` instead.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this transfer resource.


createScheduledTransfer

Create a new scheduled transfer request

This operation adds either a new one-time or a recurring transfer, depending on the content of the embedded `schedule`. The request includes the amount of the transfer in the body, and the source and target accounts in the request's `_links` via the link relations `apiture:source` and `apiture:target`. The accounts must be active and available for transfers and the amount must be in the allowed transfer range. If the request's transfer date (`schedule.start`) is the current day, the financial institution is processing transfers on that day, and the time is _before_ the financial institution's transfer processing cutoff time, internal transfers will be processed as soon as possible and the transfer `state` will change to `processing` and then `completed`. If the request's transfer date (`schedule.start`) is the current day and the time is _past_ the cutoff time, the transfer will be processed on the _next_ processing day. The cutoff time is available as `cutoffTime` via this service's `basic` configuration values `GET /transfers/configurations/groups/basic/values`; those values are defined by the JSON schema `GET /transfers/configurations/groups/basic/schema`. If the transfer is scheduled for a future date that is _not_ a valid transfer processing day, the request fails with a 400 error. The holidays and other non-processing days are available via this service's `calendar` configuration values `GET /transfers/configurations/groups/calendar/values`; those values are defined by the JSON schema `GET /transfers/configurations/groups/calendar/schema`. The service will reject duplicate requests, defined by a request that exactly matches an existing transfer (same `amount`, `schedule`, `description`, source and target accounts), returning a *409 Conflict* status. To schedule a duplicate transfer with the same amount, schedule, and accounts, change at least the `description`. Scheduled transfers will be deleted automatically at some point after they have completed (typically 7 days), up until which they are available with a `state` of `completed` if successful or `failed` if not.


/scheduledTransfers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///transfers/scheduledTransfers"
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.createScheduledTransfer()
var createScheduledTransfer = ; // {CreateScheduledTransfer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
scheduledTransferApi.createScheduledTransfer(createScheduledTransfer, callback);

Scopes

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.

Parameters

Body parameters
Name Description
createScheduledTransfer *

The data necessary to create a new transfer.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteScheduledTransfer

Delete this scheduled transfer

Delete this transfer. Any processing transfers may complete; future scheduled transfers, if this is a recurring transfer, will be canceled. After deleting a transfer, there is no direct access to the transactions or transaction errors.


/scheduledTransfers/{scheduledTransferId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///transfers/scheduledTransfers/{scheduledTransferId}"
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.deleteScheduledTransfer()
var scheduledTransferId = scheduledTransferId_example; // {String} The unique identifier of this scheduled transfer. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
scheduledTransferApi.deleteScheduledTransfer(scheduledTransferId, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
scheduledTransferId*
String
The unique identifier of this scheduled transfer. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


getScheduledTransfer

Fetch a representation of this transfer

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this transfer resource. To also receive the full account number when fetching an account, include the `?unmasked=true` option. When linking an external account, the full account number should be in the `accountNumbers.full` property in the request.


/scheduledTransfers/{scheduledTransferId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transfers/scheduledTransfers/{scheduledTransferId}?unmasked="
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.getScheduledTransfer()
var scheduledTransferId = scheduledTransferId_example; // {String} The unique identifier of this scheduled transfer. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example, // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
  'unmasked': true // {Boolean} When requesting a transfer, the full account number of the source and target accounts is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
scheduledTransferApi.getScheduledTransfer(scheduledTransferId, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
scheduledTransferId*
String
The unique identifier of this scheduled transfer. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
Query parameters
Name Description
unmasked
Boolean
When requesting a transfer, the full account number of the source and target accounts is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this transfer resource.


getScheduledTransfers

Return a collection of scheduled transfers

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.


/scheduledTransfers

Usage and SDK Samples

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);

Scopes

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.

Parameters

Query parameters
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.

Responses


patchScheduledTransfer

Update this scheduled transfer

Perform a partial update of this transfer. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included. If the `state` of the transfer allows, this operation may change the `description`, `amount`, and `schedule`; the source and target accounts and `_embedded` objects may not be changed. In the schedule, the user may not changed the `count`. The user may not change the `state`. This update operation is subject to the same constraints defined in the `createTransfer` (`POST /transfers/transfers`) operation.


/scheduledTransfers/{scheduledTransferId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///transfers/scheduledTransfers/{scheduledTransferId}"
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.patchScheduledTransfer()
var scheduledTransferId = scheduledTransferId_example; // {String} The unique identifier of this scheduled transfer. This is an opaque string.
var updateScheduledTransfer = ; // {UpdateScheduledTransfer} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
scheduledTransferApi.patchScheduledTransfer(scheduledTransferId, updateScheduledTransfer, opts, callback);

Scopes

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.

Parameters

Path parameters
Name Description
scheduledTransferId*
String
The unique identifier of this scheduled transfer. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateScheduledTransfer *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this transfer resource.


resumeScheduledTransfer

Resume a suspended scheduled transfer

`POST` the URI of a suspended scheduled transfer to resume it. This enables future recurring transfers. Any transfers that would have occurred on dates that passed while suspended will not be processed on those dates. See also the `extendSchedule` query parameter on this operation. This operation is only valid on scheduled transfers which are in the `suspended` state. This operation is invoked by submitting a `POST` to the `href` in the scheduled transfer's *`apiture:resume`* link, The link will be present if the transfer can be resumed.


/resumedScheduledTransfers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///transfers/resumedScheduledTransfers?scheduledTransfer=&scheduledTransferUri=&extendSchedule="
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.resumeScheduledTransfer()
var scheduledTransfer = scheduledTransfer_example; // {String} A server-generated key which identifies a scheduled transfer resource.
var opts = {
  'scheduledTransferUri': scheduledTransferUri_example, // {String} The URI of a scheduled transfer resource. This parameter is **deprecated** and will be removed in the next version. Use `?scheduledTransfer=` instead.
  'ifMatch': ifMatch_example, // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
  'extendSchedule': true // {Boolean} If true, the `schedule.end` will be extended if necessary so that the `maximumCount` number of transfers will be made (based on the periods in `every`).  The default value (`false`) prevents processing transfers that the user may not expect based on the original schedule. (The user may still update the `schedule.end` via `PATCH` to the scheduled transfer.)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
scheduledTransferApi.resumeScheduledTransfer(scheduledTransfer, opts, callback);

Scopes

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.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
scheduledTransfer*
String
A server-generated key which identifies a scheduled transfer resource.
Required
scheduledTransferUri
String
The URI of a scheduled transfer resource. This parameter is **deprecated** and will be removed in the next version. Use `?scheduledTransfer=` instead.
extendSchedule
Boolean
If true, the `schedule.end` will be extended if necessary so that the `maximumCount` number of transfers will be made (based on the periods in `every`). The default value (`false`) prevents processing transfers that the user may not expect based on the original schedule. (The user may still update the `schedule.end` via `PATCH` to the scheduled transfer.)

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this transfer resource.


suspendScheduledTransfer

Suspend a scheduled transfer

Suspend a scheduled recurring transfer. This disables future recurring transfers until the scheduled transfer is either resumed or canceled. Any transfers that would have occurred on dates that passed while suspended will not be processed on those dates. Use the `apiture:resume` or `apiture:cancel` links on the instance to resume or cancel the remaining transfers. This operation is only valid on scheduled transfers which are in `recurring` state, and only if the underlying bank core support suspending transfers. This operation is invoked by submitting a `POST` to the `href` in the scheduled transfer's *`apiture:suspend`* link. The service includes the *`apiture:suspend`* link in the scheduled recurring transfer _if and only if_ the user may suspend the transfer _and_ if the banking core allows suspending. If the banking core does not allow suspending a recurring transfer, the user should instead [`cancel`](#op-cancelScheduledTransfer) the transfer and create a new one. A client can check if the institution supports suspending transfers by accessing the `suspendScheduledTransfersEnabled` property in the `basic` [`getConfigurationGroupValue`](#op-getConfigurationGroupValue).


/suspendedScheduledTransfers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///transfers/suspendedScheduledTransfers?scheduledTransfer=&scheduledTransferUri="
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.suspendScheduledTransfer()
var scheduledTransfer = scheduledTransfer_example; // {String} A server-generated key which identifies a scheduled transfer resource.
var opts = {
  'scheduledTransferUri': scheduledTransferUri_example, // {String} The URI of a scheduled transfer resource. This parameter is **deprecated** and will be removed in the next version. Use `?scheduledTransfer=` instead.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
scheduledTransferApi.suspendScheduledTransfer(scheduledTransfer, opts, callback);

Scopes

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.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
scheduledTransfer*
String
A server-generated key which identifies a scheduled transfer resource.
Required
scheduledTransferUri
String
The URI of a scheduled transfer resource. This parameter is **deprecated** and will be removed in the next version. Use `?scheduledTransfer=` instead.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this transfer resource.