Banking Accounts Administration v0.6.1

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

This API allows financial institution administrators and entitled partners to access banking accounts.

• Use getAccountNumbers to map one or more account IDs to full account numbers.
• Use getBankingAccounts to view details of the requested accounts.
• Use listCustomerAccounts to list all accounts for a specific banking customer by ID.

Authenticated Access

The operations in this API require an OAuth2 access token, which may either be obtained via the Client Credentials flow (for use by secure headless applications) or by Authorization Code Flow by financial institution (FI) administrative users who authenticate with the financial institution's workforce identity provider. Non-FI partner organizations may only use Client Credentials.

Accessing Accounts for a Specific Financial Institution

The access token is associated with a unique Client ID. Client IDs are normally associated with a specific financial institution. If the Client ID is not tied to a specific institution, the client must provide the Institution-Id request header parameter to identify the target institution where the accounts and customers are held. This header is ignored otherwise.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• OAuth2 authentication (clientCredentials)
  • Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at Secure Access.
  • Flow: clientCredentials
  • Token URL = https://dev-oidc.apiture-comm-nonprod.com/oidc/token

Banking Accounts Admin

Administration of Banking Accounts at a Financial Institution

getBankingAccounts

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/bankingAccounts?accounts=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed \
  -H 'Accept: application/json' \
  -H 'Institution-Id: TIBURON' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/bankingAccounts?accounts=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed HTTP/1.1
Host: api.apiture.com
Accept: application/json
Institution-Id: TIBURON

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

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

};

fetch('https://api.apiture.com/bankingAdmin/bankingAccounts?accounts=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingAccounts',
  method: 'get',
  data: '?accounts=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/bankingAdmin/bankingAccounts',
  params: {
  'accounts' => '[bankingAccountIdSelection](#schema-bankingAccountIdSelection)'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/bankingAccounts', params={
  'accounts': [
  "6f2625952ad00ef4f701",
  "f73e992e4230a6e8ef64",
  "d1aa5570846beb619dfa",
  "ed202975b84b7acd5161",
  "b39069bdbc65c83c58ed"
]
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/bankingAccounts?accounts=6f2625952ad00ef4f701,f73e992e4230a6e8ef64,d1aa5570846beb619dfa,ed202975b84b7acd5161,b39069bdbc65c83c58ed");
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"},
        "Institution-Id": []string{"TIBURON"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

List accounts at a financial institution.

GET https://api.apiture.com/bankingAdmin/bankingAccounts

Return account details for a selected list of banking account IDs.

The response may be a partial list (202 Accepted) when some of accounts' details are not yet available and are thus incomplete (not fully populated). The client can retry the operation with the subset of accounts that were incomplete (based on the incompleteAccounts array in the response incompleteBankingAccounts), until all data has been returned or the retry limit has passed.

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "590c0c441f3241de9526",
      "maskedNumber": "*6789",
      "fullAccountNumber": "123456789",
      "routingNumber": "123123123",
      "product": {
        "type": "cd",
        "coreType": "CD",
        "code": "180D_CDA",
        "label": "180 Day CD",
        "description": "Certificate of Deposit with a 180 day term"
      },
      "location": "internal",
      "primaryOwner": {
        "id": "9ba61351e79c00ea2571"
      },
      "openedOn": "2018-10-01",
      "balance": {
        "available": "3456.78",
        "current": "3456.78",
        "updatedAt": "2021-10-30T19:06:04.250Z",
        "currentWithPending": "3456.78"
      },
      "currency": "USD",
      "state": "open"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

listCustomerAccounts

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/customerBankingAccounts?customerId=string \
  -H 'Accept: application/json' \
  -H 'Institution-Id: TIBURON' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/customerBankingAccounts?customerId=string HTTP/1.1
Host: api.apiture.com
Accept: application/json
Institution-Id: TIBURON

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

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

};

fetch('https://api.apiture.com/bankingAdmin/customerBankingAccounts?customerId=string',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerBankingAccounts',
  method: 'get',
  data: '?customerId=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/bankingAdmin/customerBankingAccounts',
  params: {
  'customerId' => '[resourceId](#schema-resourceId)'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/customerBankingAccounts', params={
  'customerId': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerBankingAccounts?customerId=string");
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"},
        "Institution-Id": []string{"TIBURON"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

List the accounts a customer is entitled to.

GET https://api.apiture.com/bankingAdmin/customerBankingAccounts

List all the banking accounts that a banking customer is entitled to access.

The response may be incomplete, indicated by a 202 Accepted response, meaning the system could not fill in all the account details in a timely manner. The client can retry the operation, passing in a list of incomplete accounts, until all data is filled in.

Parameters

Example responses

200 Response

{
  "start": "1922a8531e8384cfa71b",
  "limit": 10,
  "nextPage_url": "/bankingAdmin/customerBankingAccounts?start=47bed5d41e25d7da89e3&limit=10&customerId=a3dd92bf8d3617ba4811",
  "count": 12,
  "customerId": "a3dd92bf8d3617ba4811",
  "items": [
    {
      "id": "590c0c441f3241de9526",
      "maskedNumber": "*6789",
      "routingNumber": "123123123",
      "nickname": "College Fund",
      "label": "College Fund",
      "product": {
        "type": "cd",
        "coreType": "CD",
        "code": "180D_CDA",
        "label": "180 Day CD",
        "description": "Certificate of Deposit with a 180 day term"
      },
      "location": "internal",
      "primaryOwner": {
        "id": "9ba61351e79c00ea2571"
      },
      "openedOn": "2018-10-01",
      "currency": "USD",
      "electronicStatements": true,
      "state": "open"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

getAccountNumbers

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/accountIdMappings \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Institution-Id: TIBURON' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/accountIdMappings HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Institution-Id: TIBURON

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    "6f2625952ad00ef4f701",
    "f73e992e4230a6e8ef64",
    "d1aa5570846beb619dfa",
    "ed202975b84b7acd5161",
    "b39069bdbc65c83c58ed"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Institution-Id':'TIBURON',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/accountIdMappings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Institution-Id':'TIBURON',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/accountIdMappings',
  method: 'post',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Institution-Id' => 'TIBURON',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/bankingAdmin/accountIdMappings',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Institution-Id': 'TIBURON',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/bankingAdmin/accountIdMappings', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/accountIdMappings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Institution-Id": []string{"TIBURON"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Map one or more account resource IDs to account numbers.

POST https://api.apiture.com/bankingAdmin/accountIdMappings

Map one or more account resource IDs to full account numbers.

This operation applies a "GET over POST" pattern: it is a safe, idempotent operation, but passes data via a request body rather than via query parameters.

Body parameter

{
  "items": [
    "6f2625952ad00ef4f701",
    "f73e992e4230a6e8ef64",
    "d1aa5570846beb619dfa",
    "ed202975b84b7acd5161",
    "b39069bdbc65c83c58ed"
  ]
}

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "6f2625952ad00ef4f701",
      "number": "0123456789",
      "location": "internal"
    },
    {
      "id": "f73e992e4230a6e8ef64",
      "number": "1123456789",
      "location": "internal"
    },
    {
      "id": "d1aa5570846beb619dfa",
      "number": "2123456789",
      "location": "internal"
    },
    {
      "id": "ed202975b84b7acd5161"
    },
    {
      "id": "b39069bdbc65c83c58ed",
      "number": "4123456789",
      "location": "internal"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 422

Status Code 429

Status Code 4XX

Status Code 5XX

Schemas

accountNickname

"Payroll Checking"

Account Nickname (v1.2.0)

The nickname (friendly name) the customer has given this account. Each customer can define their own nickname for the same account. If omitted, the customer has not set a nickname.

type: string(text)

format: text
maxLength: 50

accountPermissions

{
  "billPay": false,
  "mobileCheckDeposit": true,
  "transferFrom": true,
  "transferTo": true,
  "view": true,
  "viewCards": true,
  "manageCards": false
}

Account Permissions (v0.3.0)

Flags which indicate the permissions the current authorized user has on this account item resource. Most of these properties may only be true for internal accounts. These permissions are available in account items in the accounts list. See fullAccountPermissions for all capabilities a customer has on an account (the account.allows object in the account object response from getAccount.)

Properties

accountRoutingNumber

"123123123"

Account Routing Number (v1.0.0)

An account ABA routing and transit number.

type: string

minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"

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

bankingAccountBalance

{
  "available": "3456.78",
  "current": "3456.78",
  "updatedAt": "2021-10-30T19:06:04.250Z",
  "currentWithPending": "3456.78"
}

Banking Account Balance (v1.0.0)

A banking account's balances. The fields are optional and may be omitted if the account.incomplete is true.

Properties

bankingAccountIdMapping

{
  "id": "6f2625952ad00ef4f701",
  "number": "0123456789",
  "location": "internal"
}

Banking Account ID Mapping (v1.0.0)

Maps a banking account ID to a full account number and account location.

Properties

bankingAccountIdMappings

{
  "items": [
    {
      "id": "6f2625952ad00ef4f701",
      "number": "0123456789",
      "location": "internal"
    },
    {
      "id": "f73e992e4230a6e8ef64",
      "number": "1123456789",
      "location": "internal"
    },
    {
      "id": "d1aa5570846beb619dfa",
      "number": "2123456789",
      "location": "internal"
    },
    {
      "id": "ed202975b84b7acd5161"
    },
    {
      "id": "b39069bdbc65c83c58ed",
      "number": "4123456789",
      "location": "internal"
    }
  ]
}

Banking Account ID Mappings (v1.0.1)

Maps account IDs to full account numbers.

Properties

bankingAccountIdSelection

[
  "6f2625952ad00ef4f701",
  "f73e992e4230a6e8ef64",
  "d1aa5570846beb619dfa",
  "ed202975b84b7acd5161",
  "b39069bdbc65c83c58ed"
]

Account ID Selection (v1.1.0)

A comma-separated list of unique opaque account IDs. Each value is the id of a resource in the Accounts API. The list is limited to 32 account IDs.

bankingAccountIdSelection is an array schema.

Array Elements

type: array: [resourceId]

unique items
minItems: 1
maxItems: 32

bankingAccountIds

{
  "items": [
    "6f2625952ad00ef4f701",
    "f73e992e4230a6e8ef64",
    "d1aa5570846beb619dfa",
    "ed202975b84b7acd5161",
    "b39069bdbc65c83c58ed"
  ]
}

Banking Account IDs (v1.0.0)

A list of unique opaque banking account IDs. Each value is the id of a resource in the Accounts API.

Properties

bankingAccountItem

{
  "id": "590c0c441f3241de9526",
  "maskedNumber": "*6789",
  "fullAccountNumber": "123456789",
  "routingNumber": "123123123",
  "product": {
    "type": "cd",
    "coreType": "CD",
    "code": "180D_CDA",
    "label": "180 Day CD",
    "description": "Certificate of Deposit with a 180 day term"
  },
  "location": "internal",
  "primaryOwner": {
    "id": "9ba61351e79c00ea2571"
  },
  "openedOn": "2018-10-01",
  "balance": {
    "available": "3456.78",
    "current": "3456.78",
    "updatedAt": "2021-10-30T19:06:04.250Z",
    "currentWithPending": "3456.78"
  },
  "currency": "USD",
  "state": "open"
}

Banking Account Item (v2.1.0)

Details of one banking account in a collection of accounts.

Properties

bankingAccountList

{
  "items": [
    {
      "id": "590c0c441f3241de9526",
      "maskedNumber": "*6789",
      "fullAccountNumber": "123456789",
      "routingNumber": "123123123",
      "product": {
        "type": "cd",
        "coreType": "CD",
        "code": "180D_CDA",
        "label": "180 Day CD",
        "description": "Certificate of Deposit with a 180 day term"
      },
      "location": "internal",
      "primaryOwner": {
        "id": "9ba61351e79c00ea2571"
      },
      "openedOn": "2018-10-01",
      "balance": {
        "available": "3456.78",
        "current": "3456.78",
        "updatedAt": "2021-10-30T19:06:04.250Z",
        "currentWithPending": "3456.78"
      },
      "currency": "USD",
      "state": "open"
    }
  ]
}

Banking Account List (v2.1.0)

A list of banking accounts and key details of those accounts.

Properties

bankingAccountLocation

"internal"

Banking Account Location (v1.0.0)

Indicates where an account is held:

• internal accounts at the current financial institution;
• external accounts at another financial institution;

type: string

enum values: internal, external

bankingAccountOwnerReference

{
  "id": "9ba61351e79c00ea2571",
  "name": "Max Peck"
}

Banking Account Owner Reference (v1.1.0)

Identifies the owner of a banking account: a business for a business/commercial account, or the person for a personal/retail account.

Properties

bankingAccountState

"open"

Banking Account State (v1.0.0)

The state of a banking account.

type: string

enum values: open, closed

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]$"

currencyCode

"str"

• (v1.0.0)*

A ISO 4217 currency code This is always upper case ASCII. Crypto currencies with codes longer that 3 characters are not supported.

type: string(text)

format: text
minLength: 3
maxLength: 3
pattern: "^[A-Z]{3}$"

customerBankingAccountItem

{
  "id": "590c0c441f3241de9526",
  "maskedNumber": "*6789",
  "fullAccountNumber": "123456789",
  "routingNumber": "123123123",
  "nickname": "College Fund",
  "label": "College Fund",
  "product": {
    "type": "cd",
    "coreType": "CD",
    "code": "180D_CDA",
    "label": "180 Day CD",
    "description": "Certificate of Deposit with a 180 day term"
  },
  "location": "internal",
  "primaryOwner": {
    "id": "9ba61351e79c00ea2571"
  },
  "openedOn": "2018-10-01",
  "balance": {
    "available": "13456.78",
    "current": "13456.78",
    "updatedAt": "2021-10-30T19:06:04.250Z",
    "currentWithPending": "13456.78"
  },
  "allows": {
    "transferFrom": false,
    "transferTo": false,
    "billPay": false,
    "mobileCheckDeposit": false,
    "view": true,
    "viewCards": false,
    "manageCards": false,
    "manageJointOwners": true,
    "manageOverdraftAccounts": false
  },
  "currency": "USD",
  "electronicStatements": true,
  "state": "open"
}

Customer Banking Account Item (v2.2.0)

Describes an account in the list of a banking accounts a customer has access to.

Properties

customerBankingAccounts

{
  "start": "1922a8531e8384cfa71b",
  "limit": 10,
  "nextPage_url": "/bankingAdmin/customerBankingAccounts?start=47bed5d41e25d7da89e3&limit=10&customerId=a3dd92bf8d3617ba4811",
  "count": 12,
  "customerId": "a3dd92bf8d3617ba4811",
  "items": [
    {
      "id": "590c0c441f3241de9526",
      "maskedNumber": "*6789",
      "routingNumber": "123123123",
      "nickname": "College Fund",
      "label": "College Fund",
      "product": {
        "type": "cd",
        "coreType": "CD",
        "code": "180D_CDA",
        "label": "180 Day CD",
        "description": "Certificate of Deposit with a 180 day term"
      },
      "location": "internal",
      "primaryOwner": {
        "id": "9ba61351e79c00ea2571"
      },
      "openedOn": "2018-10-01",
      "currency": "USD",
      "electronicStatements": true,
      "state": "open"
    }
  ]
}

Customer Banking Accounts (v2.2.0)

A page of customer's accounts.

Properties

fullAccountNumber

"123456789"

Full Account Number (v1.0.0)

A full account number. This is the number that the customer uses to reference the account within the financial institution.

type: string

minLength: 1
maxLength: 32
pattern: "^[- a-zA-Z0-9.]{1,32}$"

fullAccountPermissions

{
  "billPay": false,
  "mobileCheckDeposit": true,
  "transferFrom": true,
  "transferTo": true,
  "view": true,
  "viewCards": true,
  "manageCards": false
}

Full Account Permissions (v1.0.0)

Flags which indicate the permissions the current authorized user has on this account resource. Most of these properties may only be true for internal accounts. These permissions are available in account response from the getAccount operation. See accountPermissions for the subset of permission in account.allows flags in the listAccounts response.

Properties

incompleteBankingAccountItem

{
  "id": "590c0c441f3241de9526",
  "maskedNumber": "*6789",
  "fullAccountNumber": "123456789",
  "routingNumber": "123123123",
  "product": {
    "type": "cd",
    "coreType": "CD",
    "code": "180D_CDA",
    "label": "180 Day CD",
    "description": "Certificate of Deposit with a 180 day term"
  },
  "location": "internal",
  "primaryOwner": {
    "id": "9ba61351e79c00ea2571"
  },
  "openedOn": "2018-10-01",
  "currency": "USD",
  "state": "open",
  "incomplete": true
}

Incomplete Banking Account Item (v2.1.0)

Details of a banking account. Some fields may not be populated if incomplete is true while the system processes the request.

Properties

incompleteBankingAccountList

{
  "incompleteAccounts": [
    "590c0c441f3241de9526"
  ],
  "retryCount": 1,
  "items": [
    {
      "id": "590c0c441f3241de9526",
      "maskedNumber": "*6789",
      "fullAccountNumber": "123456789",
      "routingNumber": "123123123",
      "product": {
        "type": "cd",
        "coreType": "CD",
        "code": "180D_CDA",
        "label": "180 Day CD",
        "description": "Certificate of Deposit with a 180 day term"
      },
      "location": "internal",
      "primaryOwner": {
        "id": "9ba61351e79c00ea2571"
      },
      "openedOn": "2018-10-01",
      "currency": "USD",
      "state": "open",
      "incomplete": true
    }
  ]
}

Incomplete Banking Account List (v2.1.0)

A list of banking accounts and key details of those accounts.

The data may be incomplete, in which case the client can retry the operation on the subset of incomplete accounts until he data is complete or a maximum number of retries has occurred. The client should pass this object's incompleteAccounts and retryCount properties as the ?accounts= and ?retryCount= query parameters when retrying the getBankingAccounts operation.

Properties

incompleteCustomerBankingAccountItem

{
  "id": "590c0c441f3241de9562",
  "maskedNumber": "*6789",
  "fullAccountNumber": "123456789",
  "routingNumber": "123123123",
  "product": {
    "type": "cd",
    "coreType": "CD",
    "code": "180D_CDA",
    "label": "180 Day CD",
    "description": "Certificate of Deposit with a 180 day term"
  },
  "location": "internal",
  "primaryOwner": {
    "id": "9ba61351e79c00ea2571"
  },
  "openedOn": "2018-10-01",
  "currency": "USD",
  "state": "open",
  "incomplete": true,
  "nickname": "College Fund",
  "label": "College Fund",
  "electronicStatements": true
}

Incomplete Customer Banking Account Item (v2.1.0)

Details of a banking account within a partial (incomplete) response for a list of a customer's accounts. Some fields may not be populated if incomplete is true while the system processes the request.

Properties

incompleteCustomerBankingAccounts

{
  "start": "1922a8531e8384cfa71b",
  "limit": 10,
  "nextPage_url": "/bankingAdmin/customerBankingAccounts?start=47bed5d41e25d7da89e3&limit=10&retryCount=2&customerId=a3dd92bf8d3617ba4811",
  "count": 12,
  "customerId": "a3dd92bf8d3617ba4811",
  "retryCount": 2,
  "items": [
    {
      "id": "590c0c441f3241de9526",
      "maskedNumber": "*6789",
      "routingNumber": "123123123",
      "nickname": "College Fund",
      "label": "College Fund",
      "product": {
        "type": "cd",
        "coreType": "CD",
        "code": "180D_CDA",
        "label": "180 Day CD",
        "description": "Certificate of Deposit with a 180 day term"
      },
      "location": "internal",
      "primaryOwner": {
        "id": "9ba61351e79c00ea2571"
      },
      "openedOn": "2018-10-01",
      "currency": "USD",
      "electronicStatements": true,
      "state": "open",
      "incomplete": true
    }
  ]
}

Incomplete Customer Banking Accounts (v3.1.0)

A page of a customer's accounts, some of which are incomplete. Pass this object's incompleteAccounts and retryCount properties as the ?accounts= and ?retryCount= query parameters to listCustomerAccounts to fetch the remaining details for those incomplete accounts.

Properties

institutionId

"TIBURON"

Institution ID (v1.1.0)

The unique immutable identifier of a financial institution.

type: string

minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

maskedAccountNumber

"*1008"

Masked Account Number (v1.0.1)

A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.

type: string

minLength: 2
maxLength: 5
pattern: "^\*[- _a-zA-Z0-9.]{1,4}$"

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

productReference

{
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "Certificate of Deposit with a 180 day term"
}

Product Reference (v2.2.1)

A reference to a banking product.

Properties

productType

"savings"

Product Type (v2.0.0)

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

type: string

enum values: savings, checking, cd, ira, loan, creditCard

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

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}$"