Transactions v0.19.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Transactions API allows bank customers to list the transactions history associated with a banking account. The client may filter the transaction history by date, amount, transaction type, and other criteria. The transaction response is paginated since there may be many thousands of transactions for an account.

Transaction history items have a type which indicates if the item is a debit or a credit transaction or a balance line item which establishes the account's balance. Examples of debit transactions are checks drawn against an account, withdrawals, transfers from the account, fees, and adjustments. Examples of credit transactions are deposits, transfers to the account, interest, and adjustments. Check transactions include the check number.

Some transactions have associated images such as check images or deposit slips. If a transaction item has images, the hasImages property is true. The list transaction images operation returns those images.

Some transactions, such as ACH transfers or debit card payments, include information about the merchant, such as the merchant name, the merchant's website URL, and logo URL if available.

Transactions may also have a memo descriptive field and a category.

Note: The financial institution may limit transaction history to the last 12 months of data.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/banking

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based client identification. See details at Secure Access.

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. The client uses the authorization_endpoint and token_endpoint to obtain an access token to pass in the Authorization header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access.
  • OIDC Configuration URL = https://auth.apiture.com/oidc/.well-known/openid-configuration

Transactions

Banking Account Transactions

listTransactions

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/transactions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/accounts/{accountId}/transactions HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/transactions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/transactions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/transactions', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/transactions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/transactions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of transactions

GET https://api.apiture.com/banking/accounts/{accountId}/transactions

Return a paginated collection of transaction history for this internal account.

Note: this operation may return a 202 Accepted and a Retry-After response header if the server requires more time to build the list of transactions. The client should retry after that delay, as described in the 202 response below.

With the Accept: text/csv request header (instead of Accept: application/json), this operation returns a comma-separated values (CSV) text response instead of a JSON response.

The first row in the file is the CSV column headers, corresponding to the properties in the transactionItem:

Date,Type,Subtype,Check Number,Description,Amount,Balance,Posted,Memo,Category ID,Category Label,Merchant Name,Id

If a value does not exist for a record in the CSV, the corresponding column in the CSV is blank. All records have all 13 columns. For example, if the transaction has no memo, merchant, category, or check number, the row may look like

2023-04-07,credit,other,,counter deposit,120.75,2034.70,true,,,,,HR49D9289498DHJE

The CSV file contains up to limit number of transactions. If there is another page of transactions, the Link response header provides a link for fetching the next page of CSV transactions. The link URL includes a new ?start= value. The link parameter "rel" has the value "next" to indicate this is the link to the next page. For example:

Link: <https://production.api.apiture.com/banking/accounts/581ca61abab3/transactions?start=88a9e9a3cd13f742?limit=1000>; rel="next"

For Accept: application/json, the nextPage_url link in the response, if present, is a pagination link to the next page of transactions for the given filters.

This operation returns a 403 Forbidden error if the customer does not have view permissions in the account.allows object, or a 422 Unprocessable Entity if called on an external account.

The default response lists only recent transactions. Normally, this is transactions for the most recent 30 days, although for high-volume accounts, it may be a shorter period.

Parameters

Example responses

200 Response

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/accounts/c9fc25b47d52916fc9ad/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "count": 2381,
  "items": [
    {
      "id": "d62c0701-0d74",
      "type": "balance",
      "subtype": "other",
      "occurredOn": "2023-06-18",
      "amount": "0.00",
      "posted": true,
      "balance": "8509.38",
      "allows": {
        "createDispute": false
      }
    },
    {
      "id": "88f5bf17-ecc4",
      "type": "debit",
      "subtype": "check",
      "occurredOn": "2023-06-18",
      "memo": "Paid electric bill",
      "merchant": {
        "name": "B&T's Excellent Electric Co.",
        "website_url": "https://BillTedsExcellentElectricCompany.example.com/",
        "logo_url": "https://BillTedsExcellentElectricCompany.example.com/img/logos/medium.png"
      },
      "amount": "1276.21",
      "posted": true,
      "balance": "8509.38",
      "category": {
        "label": "Utilities",
        "id": "127"
      },
      "checkNumber": "8412",
      "allows": {
        "createDispute": true
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Transaction Categories

Banking Account Transaction Categories

listTransactionCategories

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/transactionCategories \
  -H 'Accept: application/json' \
  -H 'If-None-Match: string' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/transactionCategories HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'If-None-Match':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/transactionCategories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'If-None-Match':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/transactionCategories',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'If-None-Match' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/banking/transactionCategories',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/banking/transactionCategories', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/transactionCategories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-None-Match": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/banking/transactionCategories", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of transaction categories

GET https://api.apiture.com/banking/transactionCategories

Return a collection of transaction categories. The response is limited to 1,000 categories.

This is a conditional operation when the If-None-Match header is used. If the client has a transactionCategories response and the ETag returned from a previous call, this operation returns a 304 Not Modified if called again when the categories collection has not changed.

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "ef7958260dce34abddb7",
      "label": "Groceries",
      "type": "debit"
    },
    {
      "id": "f24096860ebf1383e202",
      "label": "Dining",
      "type": "debit"
    },
    {
      "id": "33c3d38ca0a744b8d903",
      "label": "Entertainment",
      "type": "debit"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Transaction Images

Images Associated With a Transaction

listTransactionImages

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a page of images associated with a transaction

GET https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images

Return the JSON representation of the images associated with this transaction.

Images include check images and deposit slips. This operation only applies to transaction items where hasImages is true. Page sizes are determined by the number of images and how many can be encoded in the API response. Use the nextPage_url from the response, if any, to fetch the next page of images.

Parameters

Example responses

200 Response

{
  "start": "1922a8531e8384cfa71b",
  "limit": 16,
  "nextPage_url": "/banking/transactions/91fd4ce044a22130f986/images?start=6",
  "count": 16,
  "images": [
    {
      "contentType": "image/png",
      "content": "SW1hZ2luZSB0aGlzIGFzIGEgUE5HIGNoZWNrIGltYWdlLCBub3QgdGV4dC4=",
      "side": "front"
    },
    {
      "contentType": "image/png",
      "content": "SW1hZ2luZSB0aGlzIGFzIGFub3RoZXIgUE5HIGNoZWNrIGltYWdlLCBub3QgdGV4dC4=",
      "side": "back"
    },
    {
      "unavailable": true
    },
    {
      "unavailable": true
    },
    {
      "contentType": "image/jpeg",
      "content": "SW1hZ2luZSB0aGlzIGFzIGEgSlBFRyBjaGVjayBpbWFnZS4=",
      "side": "front"
    },
    {
      "contentType": "image/jpeg",
      "content": "SW1hZ2luZSB0aGlzIGFzIHlldCBhbm90aGVyIEpQRUcgY2hlY2sgaW1hZ2Uu",
      "side": "back"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 422

Status Code 429

Status Code 4XX

Status Code 5XX

Schemas

amountRange

"[1000.00,1200.00)"

Amount Range (v1.2.2)

A monetary amount range, supporting inclusive or exclusive endpoints. The value may have the following forms:

• 1200.50 match the dollar amount 1,200.50 exactly
• [1000.00,1200.00) matches items where 1000.00 <= amount < 1200.00
• [1000.00,1199.99] matches items where 1000.00 <= amount <= 1199.99
• (999.99,1200.00) matches items where 999.99 < amount < 1200.00
• [1200.50,] matches items where amount >= 1200.50
• (1200.50,) matches items where amount > 1200.50
• [,1200.50] matches items where amount <= 1200.50
• (,1200.50) matches items where amount < 1200.50

type: string

minLength: 1
maxLength: 30
pattern: "^((\d+(\.\d{0,2})?)|([\[\(](((\d+(\.\d{0,2})?),((\d+(\.\d{0,2})?))?)|(,(\d+(\.\d{0,2})?)))[\]\)]))$"

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

An challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

checkNumberRange

"[1000,1200)"

Check Number Range (v1.0.0)

A numeric range for a checking account check number.

type: string

maxLength: 20
pattern: "^\d+|([[(](\d+,(\d+)?|,\d+)[)\]])$"

creditOrDebitValue

"3456.78"

Credit Or Debit Value (v1.1.0)

The monetary value representing a credit (positive amounts with no prefix or a + prefix) or debit (negative amounts with a - prefix). The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string

maxLength: 16
pattern: "^(-|\+)?(0|[1-9][0-9]*)\.[0-9][0-9]$"

incompleteTransactions

{
  "retryCount": 1
}

Incomplete Transactions (v1.0.0)

Response when requesting transactions that are not yet available.

Properties

monetaryValue

"3456.78"

Monetary Value (v1.1.0)

The monetary value, supporting only positive amounts. The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string

maxLength: 16
pattern: "^(0|[1-9][0-9]*)\.[0-9][0-9]$"

positiveIntegerRange

"[1000,1200)"

Positive Integer Range (v1.1.0)

A positive integer range, supporting inclusive or exclusive endpoints. The value may have the following forms:

• 1200 match the integer 1,200 exactly
• [1000,1200) matches items where 1000 <= number < 1200
• [1000,1199] matches items where1000 <= number <= 1199
• [999,1200] matches items where 999 < number < 1200
• [1200,] number >= 1200
• (1200,) greater than the value: number >= 1200
• [,1200] less than or equal to the value: number <= 1200
• (,1200) less than the value: number < 1200

type: string

maxLength: 20
pattern: "^\d+|([[(](\d+,(\d+)?|,\d+)[)\]])$"

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.1)

API problem or error response, as per RFC 9457 application/problem+json.

Properties

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.3)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

timestamp

"2021-10-30T19:06:04.250Z"

Timestamp (v1.0.0)

A timestamp (an instant in time) formatted in YYYY-MM-DDThh:mm:ss.sssZ RFC 3339 date-time UTC format.

type: string(date-time)

format: date-time
minLength: 20
maxLength: 30

transactionAllows

{
  "createDispute": true
}

Transaction Allows (v1.0.0)

Indicates what transaction actions are allowed for the current customer, given the user's entitlements and the state of the transaction.

Properties

transactionCategories

{
  "items": [
    {
      "id": "ef7958260dce34abddb7",
      "label": "Groceries",
      "type": "debit"
    },
    {
      "id": "f24096860ebf1383e202",
      "label": "Dining",
      "type": "debit"
    },
    {
      "id": "33c3d38ca0a744b8d903",
      "label": "Entertainment",
      "type": "debit"
    }
  ]
}

Transaction Category Collection (v1.2.0)

Collection of transaction categories. The list contains both financial institution defined immutable categories and customer defined categories.

Properties

transactionCategorization

{
  "label": "string",
  "id": "string"
}

Transaction Categorization (v1.3.0)

The transaction categorization.

Properties

transactionCategory

{
  "id": "0399abed-fd3d",
  "type": "debit",
  "label": "Dining"
}

Transaction Category (v1.2.0)

Representation of transaction category resources.

Properties

transactionCategoryLabel

"string"

Transaction Category Label (v1.2.0)

The label of a transaction category, such as "Shopping", "Deposit", "Bill", "Transfer", or "Other".

type: string(text)

format: text
minLength: 1
maxLength: 64

transactionCategoryType

"credit"

Transaction Category (v1.0.0)

Classifies a transaction category as applying to either debit or credit transactions.

transactionCategoryType strings may have one of the following enumerated values:

type: string

enum values: credit, debit

transactionHold

{
  "amount": "4000.00",
  "available": "1000.00",
  "clearsAt": "2023-06-26T12:47:23.375Z"
}

Transaction Hold (v1.0.0)

Details of a hold on this transaction. If there is no hold, this object is omitted.

Properties

transactionId

"string"

Transaction ID (v1.0.0)

The transaction's unique identifier.

type: string

read-only
minLength: 6
maxLength: 256
pattern: "^[-_:,.~$a-zA-Z0-9]{6,256}$"

transactionImage

{
  "contentType": "image/png",
  "content": "SW1hZ2luZSB0aGlzIGlzIGEgY2hlY2sgaW1hZ2UsIG5vdCB0ZXh0Lg==",
  "side": "front"
}

Transaction Image (v1.1.1)

An image associated with a transaction. Images include check images and deposit slips. If a transaction type is debit and the subtype is check, this is a check image (front or back). If the platform could not load the image, unavailable is true, and the content, contentType, and side are omitted and the message describes the problem. Otherwise, the content, contentType, and side define the transaction image.

Properties

transactionImageSide

"front"

Transaction Image Side (v1.0.0)

Indicates if an image is the front or back of the captured document.

type: string

enum values: front, back, unknown

transactionImageType

"image/png"

Transaction Image Type (v1.0.0)

The media type of a transaction image.

type: string

enum values: image/png, image/jpeg, image/gif

transactionImages

{
  "start": "1922a8531e8384cfa71b",
  "limit": 16,
  "nextPage_url": "/banking/transactions/91fd4ce044a22130f986/images?start=6",
  "count": 16,
  "images": [
    {
      "contentType": "image/png",
      "content": "SW1hZ2luZSB0aGlzIGFzIGEgUE5HIGNoZWNrIGltYWdlLCBub3QgdGV4dC4=",
      "side": "front"
    },
    {
      "contentType": "image/png",
      "content": "SW1hZ2luZSB0aGlzIGFzIGFub3RoZXIgUE5HIGNoZWNrIGltYWdlLCBub3QgdGV4dC4=",
      "side": "back"
    },
    {
      "unavailable": true
    },
    {
      "unavailable": true
    },
    {
      "contentType": "image/jpeg",
      "content": "SW1hZ2luZSB0aGlzIGFzIGEgSlBFRyBjaGVjayBpbWFnZS4=",
      "side": "front"
    },
    {
      "contentType": "image/jpeg",
      "content": "SW1hZ2luZSB0aGlzIGFzIHlldCBhbm90aGVyIEpQRUcgY2hlY2sgaW1hZ2Uu",
      "side": "back"
    }
  ]
}

Transaction Images (v2.0.2)

A page of images of documents associated with a transaction. Images include check images and deposit slips, with a front side and optional back side. All back images, if they exist, immediately follow their corresponding front image in the array.

There may be more than two images associated with a transaction if the financial institution has enabled the Deposit Item Images feature. For example, a transaction for the deposit of multiple checks may include the images of the deposit slip and the n deposited checks. When this feature is disabled, the image for such a transaction may be just the deposit slip.

If there are more images associated with this transaction, the nextPage_url property is set. Use a GET call on that URL to fetch the next page.

Properties

transactionItem

{
  "id": "88f5bf17-ecc4",
  "type": "debit",
  "subtype": "check",
  "occurredOn": "2023-05-18",
  "memo": "Paid electric bill",
  "merchant": {
    "name": "B&T's Excellent Electric Co.",
    "website_url": "https://BillTedsExcellentElectricCompany.example.com/",
    "logo_url": "https://BillTedsExcellentElectricCompany.example.com/img/logos/medium.png"
  },
  "amount": "1276.21",
  "posted": true,
  "balance": "8509.38",
  "category": {
    "label": "Utilities",
    "id": "127"
  },
  "checkNumber": "8412",
  "hasImages": true,
  "allows": {
    "createDispute": false
  }
}

Transaction Item (v5.0.0)

Summary representation of a transaction resource in transactions collections.

Properties

transactionMerchant

{
  "name": "string",
  "website_url": "../dictionary",
  "logo_url": "../dictionary"
}

Transaction Merchant (v1.1.0)

Describes the merchant associated with a transaction.

Properties

transactionSubType

"check"

Transaction Subtype (v1.0.0)

If the transaction type is debit or credit, the subtype indicates what type of debit or credit it is. The subtype values may grow in future releases.

transactionSubType strings may have one of the following enumerated values:

type: string

enum values: check, other

transactionType

"balance"

Transaction Type (v2.0.1)

Distinguishes between balance, debit, or credit transaction history items.

transactionType strings may have one of the following enumerated values:

type: string

enum values: balance, debit, credit

transactions

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/accounts/c9fc25b47d52916fc9ad/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "count": 2381,
  "items": [
    {
      "id": "d62c0701-0d74",
      "type": "balance",
      "subtype": "other",
      "occurredOn": "2023-06-18",
      "amount": "0.00",
      "posted": true,
      "balance": "8509.38",
      "allows": {
        "createDispute": false
      }
    },
    {
      "id": "88f5bf17-ecc4",
      "type": "debit",
      "subtype": "check",
      "occurredOn": "2023-06-18",
      "memo": "Paid electric bill",
      "merchant": {
        "name": "B&T's Excellent Electric Co.",
        "website_url": "https://BillTedsExcellentElectricCompany.example.com/",
        "logo_url": "https://BillTedsExcellentElectricCompany.example.com/img/logos/medium.png"
      },
      "amount": "1276.21",
      "posted": true,
      "balance": "8509.38",
      "category": {
        "label": "Utilities",
        "id": "127"
      },
      "checkNumber": "8412",
      "allows": {
        "createDispute": true
      }
    }
  ]
}

Transaction Collection (v5.0.0)

Collection of transactions. The items in the collection are ordered in the items array. The response object may contain the nextPage_url pagination link.

Properties