Transactions

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API. This API returns the following links: *`apiture:accounts`* : links to the collection of accounts held at this financial institution


/

Usage and SDK Samples

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

const aPIApi = new APIApi(configuration);

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


var api = new Transactions.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:///transactions/apiDoc"
import { APIApi } from "@apiture/transactions-client-sdk";

const aPIApi = new APIApi(configuration);

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


var api = new Transactions.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


History

getHistory

Return a collection of past transactions

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 transactions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. Transactions in the history are immutable and not deletable. The default will show transactions for all accounts that the user has access to.


/history

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transactions/history?checkNumber=&holdState=&start=&limit=&sortBy=&filter=&q=&account="
import { HistoryApi } from "@apiture/transactions-client-sdk";

const historyApi = new HistoryApi(configuration);

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

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


var api = new Transactions.HistoryApi.getHistory()
var opts = {
  'checkNumber': checkNumber_example, // {String} Specify one or more check numbers or check number ranges. This is a comma-separated or `|` separated list of number or ranges. Ranges have the form `number-number`. For example, the value `201,202,210-213` matches the transactions where the check number is 201, 202, 210, 211, 212, or 213; this may also be expressed as `201|202|210-213`.
  'holdState': holdState_example, // {String} Subset the transactions collection to those whose `holdState` matches this value. Use `|` to separate multiple values.  For example, `?holdState=active` will match only items whose `holdState` is `active`; `?holdState=active|expired` will match items whose `holdState` is `active` or `expired`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'start': 789, // {Long} The zero-based index of the first transaction in this page. The default, 0, represents the first page of the collection.
  'limit': 56, // {Integer} The maximum number of transaction 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).
  'account': account_example // {String} A list of server-supplied values which identify the account instances, i.e. ?account=acct1|acct2|acct3.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
historyApi.getHistory(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.

Parameters

Query parameters
Name Description
checkNumber
String
Specify one or more check numbers or check number ranges. This is a comma-separated or `|` separated list of number or ranges. Ranges have the form `number-number`. For example, the value `201,202,210-213` matches the transactions where the check number is 201, 202, 210, 211, 212, or 213; this may also be expressed as `201|202|210-213`.
holdState
String
Subset the transactions collection to those whose `holdState` matches this value. Use `|` to separate multiple values. For example, `?holdState=active` will match only items whose `holdState` is `active`; `?holdState=active|expired` will match items whose `holdState` is `active` or `expired`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
start
Long (int64)
The zero-based index of the first transaction in this page. The default, 0, represents the first page of the collection.
limit
Integer (int32)
The maximum number of transaction 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).
account
String
A list of server-supplied values which identify the account instances, i.e. ?account=acct1|acct2|acct3.

Responses


PendingTransactions

getPendingTransactions

Return a collection of pending transactions

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 pending transactions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. The default will show pending transactions for all accounts that the user has access to.


/pendingTransactions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transactions/pendingTransactions?checkNumber=&holdState=&start=&limit=&sortBy=&filter=&q=&account="
import { PendingTransactionsApi } from "@apiture/transactions-client-sdk";

const pendingTransactionsApi = new PendingTransactionsApi(configuration);

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

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


var api = new Transactions.PendingTransactionsApi.getPendingTransactions()
var opts = {
  'checkNumber': checkNumber_example, // {String} Specify one or more check numbers or check number ranges. This is a comma-separated or `|` separated list of number or ranges. Ranges have the form `number-number`. For example, the value `201,202,210-213` matches the transactions where the check number is 201, 202, 210, 211, 212, or 213; this may also be expressed as `201|202|210-213`.
  'holdState': holdState_example, // {String} Subset the transactions collection to those whose `holdState` matches this value. Use `|` to separate multiple values.  For example, `?holdState=active` will match only items whose `holdState` is `active`; `?holdState=active|expired` will match items whose `holdState` is `active` or `expired`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'start': 789, // {Long} The zero-based index of the first transaction in this page. The default, 0, represents the first page of the collection.
  'limit': 56, // {Integer} The maximum number of transaction 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).
  'account': account_example // {String} A list of server-supplied values which identify the account instances, i.e. ?account=acct1|acct2|acct3.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
pendingTransactionsApi.getPendingTransactions(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.

Parameters

Query parameters
Name Description
checkNumber
String
Specify one or more check numbers or check number ranges. This is a comma-separated or `|` separated list of number or ranges. Ranges have the form `number-number`. For example, the value `201,202,210-213` matches the transactions where the check number is 201, 202, 210, 211, 212, or 213; this may also be expressed as `201|202|210-213`.
holdState
String
Subset the transactions collection to those whose `holdState` matches this value. Use `|` to separate multiple values. For example, `?holdState=active` will match only items whose `holdState` is `active`; `?holdState=active|expired` will match items whose `holdState` is `active` or `expired`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
start
Long (int64)
The zero-based index of the first transaction in this page. The default, 0, represents the first page of the collection.
limit
Integer (int32)
The maximum number of transaction 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).
account
String
A list of server-supplied values which identify the account instances, i.e. ?account=acct1|acct2|acct3.

Responses


Transactions

getTransaction

Fetch a representation of this transaction

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


/transactions/{transactionId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transactions/transactions/{transactionId}?unmasked="
import { TransactionsApi } from "@apiture/transactions-client-sdk";

const transactionsApi = new TransactionsApi(configuration);

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

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


var api = new Transactions.TransactionsApi.getTransaction()
var transactionId = transactionId_example; // {String} The unique identifier of this transaction. This is an opaque string. This string is not the same as the bank's core transaction ID; it is simply the resource ID for referencing the transaction resource via the API.
var opts = {
  'unmasked': true // {Boolean} When requesting a transaction, the full account number 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);
  }
};
transactionsApi.getTransaction(transactionId, 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.

Parameters

Path parameters
Name Description
transactionId*
String
The unique identifier of this transaction. This is an opaque string. This string is not the same as the bank's core transaction ID; it is simply the resource ID for referencing the transaction resource via the API.
Required
Query parameters
Name Description
unmasked
Boolean
When requesting a transaction, the full account number 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 resource.


getTransactions

Return a collection of pending and completed transactions.

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 pending and completed transactions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. The default will show transactions for all accounts that the user has access to.


/transactions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///transactions/transactions?checkNumber=&holdState=&start=&limit=&sortBy=&filter=&q=&account="
import { TransactionsApi } from "@apiture/transactions-client-sdk";

const transactionsApi = new TransactionsApi(configuration);

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

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


var api = new Transactions.TransactionsApi.getTransactions()
var opts = {
  'checkNumber': checkNumber_example, // {String} Specify one or more check numbers or check number ranges. This is a comma-separated or `|` separated list of number or ranges. Ranges have the form `number-number`. For example, the value `201,202,210-213` matches the transactions where the check number is 201, 202, 210, 211, 212, or 213; this may also be expressed as `201|202|210-213`.
  'holdState': holdState_example, // {String} Subset the transactions collection to those whose `holdState` matches this value. Use `|` to separate multiple values.  For example, `?holdState=active` will match only items whose `holdState` is `active`; `?holdState=active|expired` will match items whose `holdState` is `active` or `expired`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'start': 789, // {Long} The zero-based index of the first transaction in this page. The default, 0, represents the first page of the collection.
  'limit': 56, // {Integer} The maximum number of transaction 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).
  'account': account_example // {String} A list of server-supplied values which identify the account instances, i.e. ?account=acct1|acct2|acct3.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
transactionsApi.getTransactions(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.

Parameters

Query parameters
Name Description
checkNumber
String
Specify one or more check numbers or check number ranges. This is a comma-separated or `|` separated list of number or ranges. Ranges have the form `number-number`. For example, the value `201,202,210-213` matches the transactions where the check number is 201, 202, 210, 211, 212, or 213; this may also be expressed as `201|202|210-213`.
holdState
String
Subset the transactions collection to those whose `holdState` matches this value. Use `|` to separate multiple values. For example, `?holdState=active` will match only items whose `holdState` is `active`; `?holdState=active|expired` will match items whose `holdState` is `active` or `expired`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
start
Long (int64)
The zero-based index of the first transaction in this page. The default, 0, represents the first page of the collection.
limit
Integer (int32)
The maximum number of transaction 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).
account
String
A list of server-supplied values which identify the account instances, i.e. ?account=acct1|acct2|acct3.

Responses