Customer Accounts v0.94.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.

Customer-level API for listing banking accounts, balances, and other account-specific data.

Clients may use this API to:

• listAccounts - obtain a list of accounts that the authorized user has access to, returning a accounts collection with a list of account objects.
• listEligibleAchAccounts - obtain a list of ACH accounts that allow transfers based on SEC code and authorized account privileges.
• listAccountBalances - list the balances of the customer' accounts.
• getAccount - fetch a more complete set of properties of an internal account.
• Manage overdraft protection:
  • listEligibleOverdraftAccounts - list accounts which may be set as overdraft protection accounts for another account.
  • getOverdraftProtection - fetch an account's overdraft protection settings.
  • patchOverdraftAccounts - update an account's overdraft protection settings.
  • setOverdraftProtectionElections - overdraft protection elections (opt in, opt out) for one or more accounts.
• Manage CD renewal settings:
  • getCdSettings - fetch an account's CD renewal settings.
  • patchCdSettings - update an account's CD renewal settings.
  • changeCdMaturityDuringGracePeriod - change a CD account's maturity during the maturity grace period.
  • listEligibleCdRenewalProducts - list products eligible for CD renewal.
  • listEligibleCdPayoutProducts - list products for CD interest payout.
• Manage peer accounts: Peer accounts are accounts owned by other account holders at the same financial institution (bank or credit union). Adding a peer account allows one account holder to transfer funds directly to another account holder's account, bypassing normal fund transfer processes like ACH. For example, a parent can add a peer account for their child's checking account (if they are both customers/members of the same financial institution) in order to directly transfer funds to their child's account. In credit unions, this is often referred to as a "member to member transfer", although this is really a transfer from one member's deposit account to another member's checking, savings, or loan account.
  • List peer accounts
  • Create a new peer account
  • Get a peer account
  • Mark a peer account as archived
  • Delete a peer account
• generateLoanPayoffQuote - fetch the loan payoff quote for a loan account.
• Manage beneficiaries:
  • listBeneficiaries - fetch the beneficiaries for an account.
  • patchBeneficiaries - update the beneficiaries for an account.
• Manage beneficial owners:
  • listBeneficialOwners - list the beneficial owners and ownership percentages for an account.
• Manage alerts:
  • getAccountAlertSubscriptions - get the alert subscriptions for an account.
  • patchAccountAlertSubscriptions - update the alert subscriptions for an account.
• Manage account collateral: Collateralization is the practice of securing an account, obligation, or financial relationship with collateral assets. Depending on the account type, the collateral may be pledged either by the financial institution or by the customer/member. Secured accounts are typically categorized as either deposit accounts (e.g., checking, savings) or loan/credit accounts. For secured deposit accounts, the financial institution pledges collateral (typically securities) to protect all or a portion of the account balance. This is commonly used when account balances exceed applicable deposit insurance limits (e.g., FDIC for banks or NCUA for credit unions). In these arrangements, pledged collateral helps ensure that funds remain protected in the event of a financial institution failure. For secured loan or credit accounts, the customer or member pledges assets to secure a borrowing relationship. Collateral may include real estate, vehicles, equipment, securities, cash deposits, or other assets. By providing collateral, borrowers may qualify for more favorable terms, such as lower interest rates, higher borrowing limits, or increased access to credit.

API Identities

This API is designed to be called from the following identity types:

• Banking customer

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 API Keys.

• 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 Access Tokens.
  • OIDC Configuration URL = https://auth.apiture.com/oidc/.well-known/openid-configuration

Accounts

Banking Accounts

listAccounts

Code samples

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

GET https://api.apiture.com/banking/accounts 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',
{
  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',
  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',
  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', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts");
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", data)
    req.Header = headers

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

List Accounts

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

Return a paginated list of the customer's accounts, consisting of internal accounts at this financial institution and accounts at other financial institutions, if any.

Parameters

Parameter	Description
unmasked in: query	boolean When requesting an account, the full account number or full member 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 (for bank accounts) or full member number (for credit unions). External accounts are excluded from unmasking. Such requests are auditable. default: false
productType in: query	array[string] Include only accounts whose product.type is in pipe-delimited set. For example, to list only savings, checking, and CD accounts, use ?productType=savings|checking|cd . unique items minItems: 1 maxItems: 9 explode: false pipe-delimited items: string » enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings, other
location in: query	string Filter accounts to just a subset of internal or external accounts (per the location property on the accountItem schema). enum values: internal, external
allows in: query	array[string] Filter the result to accounts that have corresponding true values in account.allows. For example ?allows=transferTo,transferFrom,view returns only accounts where account.allows.transferTo, account.allows.transferFrom, and account.allows.view are all true for the caller. unique items minItems: 1 maxItems: 11 explode: false comma-delimited items: string » enum values: billPay, transferFrom, transferTo, mobileCheckDeposit, view, viewCards, manageCards, viewLoanPayoffQuote, manageOverdraftProtectionElections, realTimePaymentFrom, realTimePaymentTo
start in: query	string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url. maxLength: 256 default: "" pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"
limit in: query	integer(int32) The maximum number of items to return in this paged response. format: int32 minimum: 0 maximum: 1000 default: 100

Example responses

200 Response

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100?allows=view",
  "count": 6,
  "items": [
    {
      "id": "bf23bc970b78d27691e8",
      "nickname": "Payroll Checking",
      "label": "Payroll Checking *1008",
      "product": {
        "type": "checking",
        "coreType": "DDA",
        "code": "DDA01",
        "label": "Business Checking",
        "allows": {
          "manuallyRefreshBalance": true
        }
      },
      "maskedNumber": "*1008",
      "location": "internal",
      "jointOwnersCount": 0,
      "spendableBalanceAccount": true,
      "accountPastDue": false,
      "paymentDue": false,
      "state": "active",
      "allows": {
        "transferFrom": false,
        "transferTo": true,
        "billPay": false,
        "mobileCheckDeposit": true,
        "view": true,
        "viewCards": true,
        "manageCards": false,
        "viewLoanPayoffQuote": false,
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true,
        "manageCdSettings": false,
        "manageCdProductSettings": false
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    },
    {
      "id": "b78d27691e8bf23bc970",
      "nickname": "College CD",
      "label": "College CD *2017",
      "product": {
        "type": "cd",
        "code": "CDA",
        "coreType": "CD",
        "label": "24 Month CD",
        "allows": {
          "manuallyRefreshBalance": true
        }
      },
      "maskedNumber": "*2017",
      "location": "internal",
      "jointOwnersCount": 0,
      "spendableBalanceAccount": false,
      "accountPastDue": false,
      "paymentDue": false,
      "state": "active",
      "allows": {
        "transferFrom": false,
        "transferTo": false,
        "billPay": false,
        "mobileCheckDeposit": false,
        "view": true,
        "viewCards": true,
        "manageCards": false,
        "viewLoanPayoffQuote": false,
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true,
        "manageCdSettings": false,
        "manageCdProductSettings": false
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getAccount

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId} 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}',
{
  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}',
  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}',
  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}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}");
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}", data)
    req.Header = headers

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

Get an Account

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

Return details of the customer's internal account.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
unmasked in: query	boolean When requesting an account, the full account number or full member 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 (for bank accounts) or full member number (for credit unions). External accounts are excluded from unmasking. Such requests are auditable. default: false

Example responses

200 Response

{
  "id": "bf23bc970b78d27691e8",
  "nickname": "Payroll Checking",
  "label": "Payroll Checking *1008",
  "maskedNumber": "*1008",
  "product": {
    "type": "checking",
    "coreType": "DDA",
    "code": "DDA01",
    "label": "Business Checking",
    "allows": {
      "manuallyRefreshBalance": true
    }
  },
  "location": "internal",
  "jointOwnersCount": 0,
  "spendableBalanceAccount": true,
  "accountPastDue": false,
  "paymentDue": false,
  "state": "active",
  "allows": {
    "transferFrom": false,
    "transferTo": true,
    "billPay": false,
    "mobileCheckDeposit": true,
    "view": true,
    "viewCards": true,
    "manageCards": false,
    "viewLoanPayoffQuote": false,
    "realTimePaymentFrom": true,
    "realTimePaymentTo": true,
    "manageCdSettings": false,
    "manageCdProductSettings": false,
    "manageJointOwners": true,
    "manageOverdraftAccounts": true,
    "generateVerificationLetter": true,
    "viewInterestDisbursement": false,
    "manageInterestDisbursement": false,
    "viewElectronicDocuments": true,
    "viewElectronicStatements": true,
    "viewBeneficiaries": true,
    "manageBeneficiaries": true,
    "manageAccountAccess": true,
    "manageTransfers": true,
    "manageAlerts": true,
    "stopPayments": true,
    "viewImages": true,
    "manageDisputes": true,
    "editTransactions": true,
    "manuallyRefreshBalance": true,
    "orderDebitCard": false,
    "viewCollateral": false,
    "makePayment": false
  },
  "electronicStatements": true,
  "maximumJointOwners": 15,
  "owner": {
    "name": "Amanda Cummins"
  },
  "openedOn": "2026-03-10",
  "overdraft": {
    "protectionElections": {
      "primary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      },
      "secondary": {
        "election": false
      }
    },
    "limit": "100.00"
  }
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getFullAccountNumber

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/fullAccountNumber 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}/fullAccountNumber',
{
  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}/fullAccountNumber',
  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}/fullAccountNumber',
  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}/fullAccountNumber', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/fullAccountNumber");
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}/fullAccountNumber", data)
    req.Header = headers

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

Return an account's full account number

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

Return the account's full unmasked account number. Such requests are auditable.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "fullAccountNumber": "123456789"
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getAccountBalance

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/accountBalance 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}/accountBalance',
{
  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}/accountBalance',
  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}/accountBalance',
  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}/accountBalance', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/accountBalance");
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}/accountBalance", data)
    req.Header = headers

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

Get Account Balance

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

Return the requested internal account's balance. The caller must have entitlements to view the account's details, as indicated by a true value for account.allows.view. Requests to get the balance for an account the user is not allowed to read results in a 403 Forbidden response.

Parameters

Parameter	Description
ignoreCache in: query	boolean If true, retrieve new balance data from the core rather than from the cache.
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "id": "05d00d7d-d630",
  "available": "3208.20",
  "current": "3448.72",
  "computedBalanceDifference": "-240.52",
  "currentWithPending": "3448.72",
  "updatedAt": "2022-05-02T06:51:19.375Z",
  "incomplete": false,
  "primary": {
    "balance": "3208.20",
    "label": "Available",
    "description": "The amount of money available for use, typically the previous day's closing balance plus or minus any pending transactions"
  },
  "initialFunding": false,
  "interest": {
    "yearToDate": "284.32",
    "priorYear": "837.20",
    "accrued": "60.12"
  }
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listAccountBalances

Code samples

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

GET https://api.apiture.com/banking/accountBalances 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/accountBalances',
{
  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/accountBalances',
  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/accountBalances',
  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/accountBalances', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accountBalances");
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/accountBalances", data)
    req.Header = headers

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

List Account Balances

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

Return a list of the requested internal accounts' balances. The accounts query parameter is a list of account IDs which typically comes from the getAccounts operation response. The returned list does not include external accounts. The caller must have entitlements to view each account's details, as indicated by a true value for account.allows.view. Requests to list balances for accounts the user is not allowed to read results in a 403 Forbidden response.

The response may be incomplete. Given a Retry-After response header, the client can retry the operation after a short delay, requesting only the accounts which are incomplete; see the 202 Accepted response for details.

Parameters

Parameter	Description
accounts in: query	accountIds The unique account identifiers of one or more internal accounts. (Internal accounts are those with location value of internal.) If omitted, this operation uses the accounts for which the customer has view permissions but is limited to at most 1000 accounts. Note: The account IDs are unrelated to the account number. unique items minItems: 1 maxItems: 1000 explode: false comma-delimited items: string » minLength: 6 » maxLength: 48 » pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
retryCount in: query	integer(int32) When retrying the operation, pass the retryCount from the incompleteAccountBalances response. format: int32 minimum: 1 maximum: 10

Example responses

200 Response

{
  "items": [
    {
      "id": "05d00d7d-d630",
      "available": "3208.20",
      "current": "3448.72",
      "currentWithPending": "3448.72",
      "updatedAt": "2022-05-02T06:51:19.375Z",
      "incomplete": false,
      "primary": {
        "balance": "3208.20",
        "label": "Available",
        "description": "The amount of money available for use, typically the previous day's closing balance plus or minus any pending transactions"
      },
      "initialFunding": false,
      "interest": {
        "yearToDate": "284.32",
        "priorYear": "837.20",
        "accrued": "60.12"
      }
    },
    {
      "id": "cb5d67ea-a5c3",
      "available": "1750.80",
      "current": "1956.19",
      "currentWithPending": "1956.19",
      "updatedAt": "2022-05-02T06:51:19.375Z",
      "incomplete": false,
      "primary": {
        "balance": "1956.19",
        "label": "Current",
        "description": "Total account value including principal and earned interest"
      },
      "initialFunding": false,
      "interest": {
        "yearToDate": "102.44",
        "priorYear": "308.59",
        "accrued": "23.09"
      }
    }
  ]
}

422 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://api.apiture.com/errors/invalidAccountId/v1.0.0",
  "title": "Unprocessable Entity",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No such account exists for the given account ID.",
  "instance": "https://api.apiture.com/banking/accountBalances?accounts=bb709151-575041fcd617"
}

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://api.apiture.com/errors/invalidAccountId/v1.0.0",
  "title": "Unprocessable Entity",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No such account exists for the given account ID.",
  "instance": "https://api.apiture.com/banking/accountBalances?accounts=bb709151-575041fcd617"
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listEligibleAchAccounts

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/achEligibleAccounts?allows=billPay&secCode=arc \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/achEligibleAccounts?allows=billPay&secCode=arc 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/achEligibleAccounts?allows=billPay&secCode=arc',
{
  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/achEligibleAccounts',
  method: 'get',
  data: '?allows=billPay&secCode=arc',
  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/achEligibleAccounts',
  params: {
  'allows' => 'array[string]',
'secCode' => '[achSecCode](#schema-achSecCode)'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/banking/achEligibleAccounts', params={
  'allows': [
  "billPay"
],  'secCode': 'arc'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/achEligibleAccounts?allows=billPay&secCode=arc");
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/achEligibleAccounts", data)
    req.Header = headers

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

List Eligible ACH Accounts

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

Return a paginated list of a customer's accounts that are eligible for ACH transfers based on allowed privileges.

Optionally, an agent can access a business customer's ACH accounts when acting on behalf of that business customer via the optional customerId query parameter.

Parameters

Parameter	Description
unmasked in: query	boolean When requesting an account, the full account number or full member 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 (for bank accounts) or full member number (for credit unions). External accounts are excluded from unmasking. Such requests are auditable. default: false
allows in: query	array[string] (required) Filter the result to accounts that have corresponding true values in account.allows. For example ?allows=transferTo,transferFrom,view returns only accounts where account.allows.transferTo, account.allows.transferFrom, and account.allows.view are all true for the caller. unique items minItems: 1 maxItems: 11 comma-delimited items: string » enum values: billPay, transferFrom, transferTo, mobileCheckDeposit, view, viewCards, manageCards, viewLoanPayoffQuote, manageOverdraftProtectionElections, realTimePaymentFrom, realTimePaymentTo
secCode in: query	achSecCode (required) Filter the result to accounts that allow ACH transfers of the given Standard Entry Class (SEC) codes. enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web
customerId in: query	resourceId The optional identifier of a business customer. This is an opaque string. An agent who is operating on behalf of a business can use this to access the resources of that business customer. The agent must have entitlements to act on behalf of the business; if not, the operation returns a 403 Forbidden response. This must match the business' customer ID (not their access ID). For other situations, omit this value. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
start in: query	string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url. maxLength: 256 default: "" pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"
limit in: query	integer(int32) The maximum number of items to return in this paged response. format: int32 minimum: 0 maximum: 1000 default: 100

Example responses

200 Response

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100?allows=view",
  "count": 6,
  "items": [
    {
      "id": "bf23bc970b78d27691e8",
      "nickname": "Payroll Checking",
      "label": "Payroll Checking *1008",
      "product": {
        "type": "checking",
        "coreType": "DDA",
        "code": "DDA01",
        "label": "Business Checking",
        "allows": {
          "manuallyRefreshBalance": true
        }
      },
      "maskedNumber": "*1008",
      "location": "internal",
      "jointOwnersCount": 0,
      "spendableBalanceAccount": true,
      "accountPastDue": false,
      "paymentDue": false,
      "state": "active",
      "allows": {
        "transferFrom": false,
        "transferTo": true,
        "billPay": false,
        "mobileCheckDeposit": true,
        "view": true,
        "viewCards": true,
        "manageCards": false,
        "viewLoanPayoffQuote": false,
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true,
        "manageCdSettings": false,
        "manageCdProductSettings": false
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    },
    {
      "id": "b78d27691e8bf23bc970",
      "nickname": "College CD",
      "label": "College CD *2017",
      "product": {
        "type": "cd",
        "code": "CDA",
        "coreType": "CD",
        "label": "24 Month CD",
        "allows": {
          "manuallyRefreshBalance": true
        }
      },
      "maskedNumber": "*2017",
      "location": "internal",
      "jointOwnersCount": 0,
      "spendableBalanceAccount": false,
      "accountPastDue": false,
      "paymentDue": false,
      "state": "active",
      "allows": {
        "transferFrom": false,
        "transferTo": false,
        "billPay": false,
        "mobileCheckDeposit": false,
        "view": true,
        "viewCards": true,
        "manageCards": false,
        "viewLoanPayoffQuote": false,
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true,
        "manageCdSettings": false,
        "manageCdProductSettings": false
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listEligibleRealTimePaymentAccounts

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/realTimePaymentEligibleAccounts?allows=realTimePaymentFrom \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/realTimePaymentEligibleAccounts?allows=realTimePaymentFrom 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/realTimePaymentEligibleAccounts?allows=realTimePaymentFrom',
{
  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/realTimePaymentEligibleAccounts',
  method: 'get',
  data: '?allows=realTimePaymentFrom',
  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/realTimePaymentEligibleAccounts',
  params: {
  'allows' => 'array[string]'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/banking/realTimePaymentEligibleAccounts', params={
  'allows': [
  "realTimePaymentFrom"
]
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/realTimePaymentEligibleAccounts?allows=realTimePaymentFrom");
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/realTimePaymentEligibleAccounts", data)
    req.Header = headers

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

List Eligible Real-Time Payment Accounts

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

Return a paginated list of a customer's accounts that are eligible for sending or receiving real-time payments based on allowed privileges.

Optionally, an agent can access a business customer's real-time payment eligible accounts when acting on behalf of that business customer via the optional customerId query parameter.

Parameters

Parameter	Description
unmasked in: query	boolean When requesting an account, the full account number or full member 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 (for bank accounts) or full member number (for credit unions). External accounts are excluded from unmasking. Such requests are auditable. default: false
allows in: query	array[string] (required) Filter the result to real-time payment accounts that have corresponding true values in account.allows. For example ?allows=realTimePaymentTo,realTimePaymentFrom returns only accounts where account.allows.realTimePaymentTo and account.allows.realTimePaymentFrom are both true for the caller. unique items minItems: 1 maxItems: 2 comma-delimited items: string » enum values: realTimePaymentFrom, realTimePaymentTo
customerId in: query	resourceId The optional identifier of a business customer. This is an opaque string. An agent who is operating on behalf of a business can use this to access the resources of that business customer. The agent must have entitlements to act on behalf of the business; if not, the operation returns a 403 Forbidden response. This must match the business' customer ID (not their access ID). For other situations, omit this value. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
start in: query	string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url. maxLength: 256 default: "" pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"
limit in: query	integer(int32) The maximum number of items to return in this paged response. format: int32 minimum: 0 maximum: 1000 default: 100

Example responses

200 Response

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100?allows=view",
  "count": 6,
  "items": [
    {
      "id": "bf23bc970b78d27691e8",
      "nickname": "Payroll Checking",
      "label": "Payroll Checking *1008",
      "maskedNumber": "*1008",
      "location": "internal",
      "allows": {
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    },
    {
      "id": "b78d27691e8bf23bc970",
      "nickname": "College CD",
      "label": "College CD *2017",
      "maskedNumber": "*2017",
      "location": "internal",
      "allows": {
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

generateVerificationLetter

Code samples

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

POST https://api.apiture.com/banking/accounts/{accountId}/verificationLetter HTTP/1.1
Host: api.apiture.com
Accept: application/pdf

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/verificationLetter");
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{
        "Accept": []string{"application/pdf"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Generate the account verification letter

POST https://api.apiture.com/banking/accounts/{accountId}/verificationLetter

Generate an account verification letter for this internal account, documenting that the banking customer owns the given account.

Until the process of generating the letter has finished, this returns 202 Accepted; the response includes a Retry-After response header with a recommended retry interval in seconds. The client should wait that number of seconds before requesting the verification letter again.

If the letter has been generated for this account, the operation returns 200 OK. The response body is the Base64-encoded account verification letter in PDF format.

This operation returns a 403 Forbidden if the user does not have the account.allows.generateVerificationLetter permission on the account.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

202 Response

{}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

generateLoanPayoffQuote

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/accounts/{accountId}/loanPayoffQuote \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/banking/accounts/{accountId}/loanPayoffQuote HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Accept-Language: string

const fetch = require('node-fetch');
const inputBody = '{
  "payoffOn": "2024-07-22"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Accept-Language':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/loanPayoffQuote',
{
  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',
  'Accept-Language':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/loanPayoffQuote',
  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',
  'Accept-Language' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/loanPayoffQuote");
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"},
        "Accept-Language": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Generate loan payoff quote

POST https://api.apiture.com/banking/accounts/{accountId}/loanPayoffQuote

Generate a quote with the amount and effective date for a loan payoff based on a requested target date.

The effective date may be adjusted from the target date due to banking holidays or other restricted dates.

The amount includes daily accrued interest up to and including the effective payoff date.

This operation is only allowed if the banking customer has the viewLoanPayoffQuote entitlement on the account.

Body parameter

{
  "payoffOn": "2024-07-22"
}

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
Accept-Language in: header	string(text) The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231. If no localized data is available that matches the requested language tag, the default US English data is returned. format: text maxLength: 128
body	loanPayoffQuoteRequest (required) Data necessary to generate a loan payoff quote.

Example responses

200 Response

{
  "amount": {
    "value": "1000.00",
    "currency": "USD"
  },
  "payoffOn": "2024-07-22",
  "payoffEffectiveOn": "2024-07-22",
  "label": "The payoff amount of $1,0000.00 is valid through Monday, July 22 2024."
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Peer Accounts

Peer Accounts

listPeerAccounts

Code samples

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

GET https://api.apiture.com/banking/peerAccounts 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/peerAccounts',
{
  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/peerAccounts',
  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/peerAccounts',
  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/peerAccounts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/peerAccounts");
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/peerAccounts", data)
    req.Header = headers

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

Return a collection of peer accounts

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

Return a list of the peer accounts owned by the banking customer/member.

Note: the default response includes peer accounts in all states. To list only active accounts use the ?state=active filter.

Parameters

Parameter	Description
state in: query	array[string] Return only peer accounts which are in any of the listed states. For example, with ?state=active, the list includes only peer accounts where peerAccount.state is "active". unique items minItems: 1 maxItems: 3 explode: false pipe-delimited items: string » enum values: active, archived
allows in: query	array[object] Return only peer accounts which have all the listed permissions. For example, with ?allows=transferFrom,transferTo, the list includes only peer accounts where peerAccount.allows.transferFrom is true and peerAccount.allows.transferTo is true. unique items minItems: 1 maxItems: 6 explode: false comma-delimited items: object

Example responses

200 Response

{
  "maximumPeerAccounts": 15,
  "totalCount": 2,
  "items": [
    {
      "id": "211683072e1d6c05d9bb",
      "firstName": "Phil",
      "lastName": "Chase",
      "nickname": "Phil's checking",
      "label": "Phil's checking",
      "state": "active",
      "type": "checking",
      "createdAt": "2024-03-21T07:56:02.375Z"
    },
    {
      "id": "5a7a84543f3328c96389",
      "firstName": "Sally",
      "lastName": "Chase",
      "nickname": "Sally's savings",
      "label": "Sally's savings",
      "state": "active",
      "type": "savings",
      "createdAt": "2024-03-21T07:56:02.375Z"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

createPeerAccount

Code samples

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

POST https://api.apiture.com/banking/peerAccounts HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "creditUnion": {
    "fullMemberNumber": "4002",
    "suffix": "C001"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/peerAccounts',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/peerAccounts',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/peerAccounts");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Create a new peer account

POST https://api.apiture.com/banking/peerAccounts

Create a new peer account.

Body parameter

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "creditUnion": {
    "fullMemberNumber": "4002",
    "suffix": "C001"
  }
}

Parameters

Parameter	Description
body	newPeerAccount (required) The data necessary to create a new peer account.

Example responses

201 Response

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "id": "211683072e1d6c05d9bb",
  "label": "Phil's checking",
  "state": "active",
  "creditUnion": {
    "maskedMemberNumber": "*02",
    "suffix": "C001"
  },
  "allows": {
    "transferTo": true,
    "transferFrom": false,
    "delete": false,
    "archive": true,
    "patch": true,
    "replace": true
  },
  "createdAt": "2024-03-21T07:56:02.375Z",
  "hasPendingTransfers": true,
  "hasFailedTransfers": false
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getPeerAccount

Code samples

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

GET https://api.apiture.com/banking/peerAccounts/{peerAccountId} 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/peerAccounts/{peerAccountId}',
{
  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/peerAccounts/{peerAccountId}',
  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/peerAccounts/{peerAccountId}',
  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/peerAccounts/{peerAccountId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/peerAccounts/{peerAccountId}");
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/peerAccounts/{peerAccountId}", data)
    req.Header = headers

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

Fetch a representation of this peer account

GET https://api.apiture.com/banking/peerAccounts/{peerAccountId}

Return the JSON representation of this peer account resource.

Parameters

Parameter	Description
unmasked in: query	boolean When requesting an account, the full account number or full member 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 (for bank accounts) or full member number (for credit unions). External accounts are excluded from unmasking. Such requests are auditable. default: false
peerAccountId in: path	resourceId (required) The unique identifier of this peer account. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "id": "211683072e1d6c05d9bb",
  "label": "Phil's checking",
  "state": "active",
  "creditUnion": {
    "maskedMemberNumber": "*02",
    "suffix": "C001"
  },
  "allows": {
    "transferTo": true,
    "transferFrom": false,
    "delete": false,
    "archive": true,
    "patch": true,
    "replace": true
  },
  "createdAt": "2024-03-21T07:56:02.375Z",
  "hasPendingTransfers": true,
  "hasFailedTransfers": false
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchPeerAccount

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/banking/peerAccounts/{peerAccountId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/banking/peerAccounts/{peerAccountId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "nickname": "Martin's college allowance checking"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/peerAccounts/{peerAccountId}',
{
  method: 'PATCH',
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/peerAccounts/{peerAccountId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

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

result = RestClient.patch 'https://api.apiture.com/banking/peerAccounts/{peerAccountId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.apiture.com/banking/peerAccounts/{peerAccountId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/peerAccounts/{peerAccountId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Patch a peer account.

PATCH https://api.apiture.com/banking/peerAccounts/{peerAccountId}

Patch mutable properties of a peer account. Only the nickname is mutable.

Changing the account identification properties (first/last name, account type, bank.fullAccountNumber or creditUnion.fullMemberNumber or suffix) is not supported. Instead, use replacePeerAccount to replace this peer account with a new peer account with the new account identification properties.

Body parameter

{
  "nickname": "Martin's college allowance checking"
}

Parameters

Parameter	Description
body	peerAccountPatch (required) The patch to apply to this peer account.
peerAccountId in: path	resourceId (required) The unique identifier of this peer account. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "id": "211683072e1d6c05d9bb",
  "label": "Phil's checking",
  "state": "active",
  "creditUnion": {
    "maskedMemberNumber": "*02",
    "suffix": "C001"
  },
  "allows": {
    "transferTo": true,
    "transferFrom": false,
    "delete": false,
    "archive": true,
    "patch": true,
    "replace": true
  },
  "createdAt": "2024-03-21T07:56:02.375Z",
  "hasPendingTransfers": true,
  "hasFailedTransfers": false
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

deletePeerAccount

Code samples

# You can also use wget
curl -X DELETE https://api.apiture.com/banking/peerAccounts/{peerAccountId} \
  -H 'Accept: application/problem+json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.apiture.com/banking/peerAccounts/{peerAccountId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json

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

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

};

fetch('https://api.apiture.com/banking/peerAccounts/{peerAccountId}',
{
  method: 'DELETE',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/banking/peerAccounts/{peerAccountId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.apiture.com/banking/peerAccounts/{peerAccountId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api.apiture.com/banking/peerAccounts/{peerAccountId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/peerAccounts/{peerAccountId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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/problem+json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Delete this peer account resource

DELETE https://api.apiture.com/banking/peerAccounts/{peerAccountId}

Delete this peer account resource. Deletion is only allowed if peerAccount.allows.delete is true. Use archivePeerAccount to indicate a peer account should not be used for future transfers.

Parameters

Parameter	Description
peerAccountId in: path	resourceId (required) The unique identifier of this peer account. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

401 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://api.apiture.com/errors/unauthorized/v1.0.0",
  "title": "Unauthorized",
  "status": 401,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "The request lacks valid authentication credentials",
  "instance": "https://api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

409 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://api.apiture.com/errors/cannotDeletePeerAccount/v1.0.0",
  "title": "Conflict",
  "status": 409,
  "occurredAt": "2024-03-21T10:43:14.375Z",
  "detail": "The caller cannot delete a peer account that is in use in pending transfers.",
  "instance": "https://api.apiture.com/banking/peerAccounts/676dc7534d3c8d0e77ac"
}

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://api.apiture.com/errors/cannotDeletePeerAccount/v1.0.0",
  "title": "Conflict",
  "status": 409,
  "occurredAt": "2024-03-21T10:43:14.375Z",
  "detail": "The caller cannot delete a peer account that is in use in pending transfers.",
  "instance": "https://api.apiture.com/banking/peerAccounts/676dc7534d3c8d0e77ac"
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Peer Account Actions

Actions on Peer Accounts

replacePeerAccount

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "creditUnion": {
    "fullMemberNumber": "4002",
    "suffix": "C001"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement',
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Replace this peer account with a revised peer account.

POST https://api.apiture.com/banking/peerAccounts/{peerAccountId}/replacement

Key account identifying attributes of a peer account are not mutable; patchPeerAccount only allows changing the nickname. Instead of mutating a peer account, this operation replaces an active peer account with a revised instance based on properties in the request body. The replacement is a 1-to-1 copy of the source peer account and its nested objects, with properties provided in the request body replacing corresponding properties in the source peer account as per JSON Merge Patch (RFC 7386) semantics. The replacement peer account is assigned unique id.

Note: This operation deletes the source peer account at /peerAccounts/{peerAccountId} if allows.delete is true, otherwise this archives the source peer account.

Note: Any historical transfers or banking event history items remain associated with the source archived peer account, not the replacement. Any pending transfers are updated with the replacement peer account.

Body parameter

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "creditUnion": {
    "fullMemberNumber": "4002",
    "suffix": "C001"
  }
}

Parameters

Parameter	Description
body	peerAccountReplacement (required) The patch to apply to this peer account.
peerAccountId in: path	resourceId (required) The unique identifier of this peer account. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

201 Response

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "id": "211683072e1d6c05d9bb",
  "label": "Phil's checking",
  "state": "active",
  "creditUnion": {
    "maskedMemberNumber": "*02",
    "suffix": "C001"
  },
  "allows": {
    "transferTo": true,
    "transferFrom": false,
    "delete": false,
    "archive": true,
    "patch": true,
    "replace": true
  },
  "createdAt": "2024-03-21T07:56:02.375Z",
  "hasPendingTransfers": true,
  "hasFailedTransfers": false
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

archivePeerAccount

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/banking/peerAccounts/{peerAccountId}/archived \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/banking/peerAccounts/{peerAccountId}/archived 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/peerAccounts/{peerAccountId}/archived',
{
  method: 'POST',

  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/peerAccounts/{peerAccountId}/archived',
  method: 'post',

  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.post 'https://api.apiture.com/banking/peerAccounts/{peerAccountId}/archived',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/banking/peerAccounts/{peerAccountId}/archived', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/peerAccounts/{peerAccountId}/archived");
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{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Archive a peer account

POST https://api.apiture.com/banking/peerAccounts/{peerAccountId}/archived

Archive a peer account. This changes the state of the peer account to archived. The response is the updated representation of the peer account. This operation is idempotent: no changes are made if the peer account is already archived.

Note: to exclude archived peer accounts in the listPeerAccounts response, use the ?state=active filter.

Parameters

Parameter	Description
peerAccountId in: path	resourceId (required) The unique identifier of this peer account. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "id": "211683072e1d6c05d9bb",
  "label": "Phil's checking",
  "state": "active",
  "creditUnion": {
    "maskedMemberNumber": "*02",
    "suffix": "C001"
  },
  "allows": {
    "transferTo": true,
    "transferFrom": false,
    "delete": false,
    "archive": true,
    "patch": true,
    "replace": true
  },
  "createdAt": "2024-03-21T07:56:02.375Z",
  "hasPendingTransfers": true,
  "hasFailedTransfers": false
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Account Joint Owners

Account Joint Owners

listAccountJointOwners

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/jointOwners 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}/jointOwners',
{
  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}/jointOwners',
  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}/jointOwners',
  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}/jointOwners', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/jointOwners");
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}/jointOwners", data)
    req.Header = headers

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

Return a collection of account joint owners

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

Return a collection of account joint owners. The user must have the account.manageJointOwners permission to use this operation.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "db821618461ade2c5e45",
      "name": "Max Pike"
    },
    {
      "id": "1ef8f2bdfc729ea2b80b",
      "name": "Sam K. Pike"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

createJointOwnerInvitation

Code samples

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

POST https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "firstName": "Mary",
  "lastName": "Jones",
  "taxId": "3333",
  "sharedSecret": "obsolete obese octopus",
  "emailAddress": "Mary.Jones@example.com",
  "birthdate": "2000-04-10"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Invite a joint owner

POST https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations

Create and send an invitation to another person to become a joint owner of the account. The invitation will be sent to the invitee's email address. The invitation directs the invitee to a web page to verify and accept the invitation, and if necessary, enroll in digital banking.

The authenticated user must have the account.allows.manageJointOwners permission to use this operation.

Body parameter

{
  "firstName": "Mary",
  "lastName": "Jones",
  "taxId": "3333",
  "sharedSecret": "obsolete obese octopus",
  "emailAddress": "Mary.Jones@example.com",
  "birthdate": "2000-04-10"
}

Parameters

Parameter	Description
body	newJointOwnerInvitation (required) Data necessary to invite a joint owner.
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "id": "db4f580290d3e07bf55d",
  "firstName": "Mary",
  "lastName": "Jones",
  "taxId": "3333",
  "sharedSecret": "obsolete obese octopus",
  "emailAddress": "Mary.Jones@example.com",
  "birthdate": "2000-04-10"
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Overdraft Protection

Overdraft Protection Settings

listEligibleOverdraftAccounts

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts 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}/eligibleOverdraftAccounts',
{
  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}/eligibleOverdraftAccounts',
  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}/eligibleOverdraftAccounts',
  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}/eligibleOverdraftAccounts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts");
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}/eligibleOverdraftAccounts", data)
    req.Header = headers

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

List Eligible Overdraft Accounts

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

Return a paginated list of a customer's accounts that are eligible to serve as overdraft protection accounts for the given account. An overdraft protection account is a deposit account that the financial institution can transfer funds from to prevent the account balance from going negative and incurring non-sufficient funds fees.

The user must have the allows.manageOverdraftAccounts permission on the account to use this operation.

To obtain available balances for these accounts, use listAccountBalances.

Parameters

Parameter	Description
start in: query	string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url. maxLength: 256 default: "" pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"
limit in: query	integer(int32) The maximum number of items to return in this paged response. format: int32 minimum: 0 maximum: 1000 default: 100
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://api.apiture.com/banking/accounts/f204d292df9fb/eligibleOverdraftAccounts?start=641f62296ecbf1882c84?limit=100",
  "items": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ],
  "maximumOverdraftAccounts": 1
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

setOverdraftProtectionElections

Code samples

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

POST https://api.apiture.com/banking/overdraftProtectionElections HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    {
      "id": "4b350c7462d9722b94ef",
      "primary": true,
      "secondary": true
    },
    {
      "id": "15de200607a00c8a2aef",
      "primary": false,
      "secondary": false
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/overdraftProtectionElections',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/overdraftProtectionElections',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/overdraftProtectionElections");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Update overdraft protection elections for one or more accounts

POST https://api.apiture.com/banking/overdraftProtectionElections

Update overdraft protection elections (opt-in or opt out) for one or more banking accounts. The operation fails (403 Forbidden) if the authorized caller does not have access to manage overdraft protection elections to all of the accounts in the request. (Note: Only use this operation for accounts returned from listAccounts with ?allows= query that includes manageOverdraftProtectionElections; the operation failed with a 403 Forbidden if the request includes accounts without that permission.)

This operation is idempotent: no changes are made if the valid overdraft elections for each account already match the request (returns 200 OK).

Body parameter

{
  "items": [
    {
      "id": "4b350c7462d9722b94ef",
      "primary": true,
      "secondary": true
    },
    {
      "id": "15de200607a00c8a2aef",
      "primary": false,
      "secondary": false
    }
  ]
}

Parameters

Parameter	Description
body	bulkAccountOverdraftProtectionElectionsUpdate (required) The updated overdraft account elections.

Example responses

200 Response

{
  "items": [
    {
      "id": "4b350c7462d9722b94ef",
      "primary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      },
      "secondary": {
        "election": false,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      }
    },
    {
      "id": "15de200607a00c8a2aef",
      "primary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      },
      "secondary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getOverdraftProtection

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection 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}/overdraftProtection',
{
  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}/overdraftProtection',
  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}/overdraftProtection',
  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}/overdraftProtection', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection");
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}/overdraftProtection", data)
    req.Header = headers

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

Fetch a representation of the account's overdraft protection settings

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

Return the JSON representation of this account's overdraft protection settings.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "maximumOverdraftAccounts": 1,
  "accounts": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ],
  "elections": {
    "primary": {
      "election": true,
      "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
    },
    "secondary": {
      "election": false
    }
  }
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchOverdraftAccounts

Code samples

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

PATCH https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection',
{
  method: 'PATCH',
  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',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Update the overdraft accounts

PATCH https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection

Perform a partial update of the overdraft accounts. Only fields in the request body are updated on the resource; fields which are omitted are not updated. To add, replace, or remove an overdraft account, add, replace, or remove the corresponding account item from the items array. Only the account id in the items is significant.

The user must have the allows.manageOverdraftAccounts permission on the account to use this operation.

Body parameter

{
  "items": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ]
}

Parameters

Parameter	Description
body	overdraftProtectionPatch (required) The replacement overdraft accounts.
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "maximumOverdraftAccounts": 1,
  "accounts": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ],
  "elections": {
    "primary": {
      "election": true,
      "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
    },
    "secondary": {
      "election": false
    }
  }
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Account CD Settings

Account CD Renewal Settings

getCdSettings

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/cdSettings 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}/cdSettings',
{
  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}/cdSettings',
  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}/cdSettings',
  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}/cdSettings', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/cdSettings");
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}/cdSettings", data)
    req.Header = headers

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

Return an account's CD settings

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

Return an account's CD settings. This operation is only available if the account's type is cd and the caller has the allows.view permission for the account.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "maturesAt": "2023-10-30T08:00:00.000Z",
  "term": "P6M",
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "inDebitGracePeriod": true,
  "inCreditGracePeriod": true,
  "debitGracePeriodStartsOn": "2023-11-01",
  "creditGracePeriodStartsOn": "2023-11-01",
  "debitGracePeriodEndsOn": "2023-11-11",
  "creditGracePeriodEndsOn": "2023-11-11"
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchCdSettings

Code samples

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

PATCH https://api.apiture.com/banking/accounts/{accountId}/cdSettings HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/cdSettings',
{
  method: 'PATCH',
  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',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/cdSettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Update an account's CD settings

PATCH https://api.apiture.com/banking/accounts/{accountId}/cdSettings

Update an account's CD settings. This operation is only available if the account's type is cd and the caller has the allows.edit permission for the account.

Body parameter

{
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  }
}

Parameters

Parameter	Description
dryRun in: query	boolean Indicates that the associated operation should only validate the request and not change the state. If the request is valid, the operation returns 204 No Content. If the request is invalid, it returns the corresponding 4xx error response. default: false
body	cdAccountSettingsPatch (required) Mutable CD settings. Unevaluated Properties: false
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "maturesAt": "2023-10-30T08:00:00.000Z",
  "term": "P6M",
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "inDebitGracePeriod": true,
  "inCreditGracePeriod": true,
  "debitGracePeriodStartsOn": "2023-11-01",
  "creditGracePeriodStartsOn": "2023-11-01",
  "debitGracePeriodEndsOn": "2023-11-11",
  "creditGracePeriodEndsOn": "2023-11-11"
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

changeCdMaturityDuringGracePeriod

Code samples

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

POST https://api.apiture.com/banking/accounts/{accountId}/maturedCd HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/maturedCd',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/banking/accounts/{accountId}/maturedCd',
  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',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/maturedCd");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Change a CD account's maturity during the maturity grace period

POST https://api.apiture.com/banking/accounts/{accountId}/maturedCd

Change a CD account during the maturity grace period. This operation allows actively changing CD settings during the maturity grace period, but not after the maturity grace period has ended. Available changes depend on the financial institution's policies but may include changes to the CD account's rollover product and/or setting up a maturity transfer to another CD account or product. The changes take effect immediately and apply to the current maturity cycle if the account is still in the maturity grace period. Allowed policies are defined in the Institutions API.

Any previous money movements from maturity of the CD are not reversed, but the new settings apply to future rollovers and maturities.

Repeating this operation with the same request body is idempotent: no net changes or visible effects occur. However, if the request body changes money movement settings (such as the interest payout account), repeating with different data may trigger additional money movement and is therefore not idempotent.

This operation is only available if the account's type is cd and the caller has the allows.manageCdProductSettings permission for the account.

Body parameter

{
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  }
}

Parameters

Parameter	Description
dryRun in: query	boolean Indicates that the associated operation should only validate the request and not change the state. If the request is valid, the operation returns 204 No Content. If the request is invalid, it returns the corresponding 4xx error response. default: false
body	cdAccountMaturityRequest (required) Mutable CD maturity settings to change during the maturity grace period. Unevaluated Properties: false
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "maturesAt": "2023-10-30T08:00:00.000Z",
  "term": "P6M",
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "inDebitGracePeriod": true,
  "inCreditGracePeriod": true,
  "debitGracePeriodStartsOn": "2023-11-01",
  "creditGracePeriodStartsOn": "2023-11-01",
  "debitGracePeriodEndsOn": "2023-11-11",
  "creditGracePeriodEndsOn": "2023-11-11"
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listEligibleCdRenewalProducts

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/eligibleCdRenewalProducts 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}/eligibleCdRenewalProducts',
{
  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}/eligibleCdRenewalProducts',
  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}/eligibleCdRenewalProducts',
  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}/eligibleCdRenewalProducts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/eligibleCdRenewalProducts");
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}/eligibleCdRenewalProducts", data)
    req.Header = headers

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

List Eligible CD Renewal Products

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

Return a list of products eligible for renewal of the specified CD account. This operation is only available if the account's type is cd and the caller has the allows.view permission for the account.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "3c1fecca79d826f86a6b",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "30D_CDA",
      "label": "30 Day CD",
      "description": "30-day Certificate of Deposit account that earns 1.50%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "97321f98fece14faa978",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "90D_CDA",
      "label": "90 Day CD",
      "description": "90-day Certificate of Deposit account that earns 1.55%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "3545997133afaf3dcd30",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "180D_CDA",
      "label": "180 Day CD",
      "description": "180-day Certificate of Deposit account that earns 1.60%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "37fcd855d7873549584d",
      "type": "savings",
      "customerType": "personal",
      "coreType": "SAV",
      "code": "SAV_01",
      "label": "Basic Savings",
      "description": "Basic savings account that earns 0.15%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listEligibleCdPayoutProducts

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/eligibleCdPayoutProducts 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}/eligibleCdPayoutProducts',
{
  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}/eligibleCdPayoutProducts',
  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}/eligibleCdPayoutProducts',
  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}/eligibleCdPayoutProducts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/eligibleCdPayoutProducts");
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}/eligibleCdPayoutProducts", data)
    req.Header = headers

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

List Eligible CD Payout Products

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

Return a list of products eligible for interest payout of the specified CD account. This operation is only available if the account's type is cd and the caller has the allows.view permission for the account.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "3c1fecca79d826f86a6b",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "30D_CDA",
      "label": "30 Day CD",
      "description": "30-day Certificate of Deposit account that earns 1.50%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "97321f98fece14faa978",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "90D_CDA",
      "label": "90 Day CD",
      "description": "90-day Certificate of Deposit account that earns 1.55%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "3545997133afaf3dcd30",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "180D_CDA",
      "label": "180 Day CD",
      "description": "180-day Certificate of Deposit account that earns 1.60%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "37fcd855d7873549584d",
      "type": "savings",
      "customerType": "personal",
      "coreType": "SAV",
      "code": "SAV_01",
      "label": "Basic Savings",
      "description": "Basic savings account that earns 0.15%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Account Beneficiaries

Account Beneficiaries

listBeneficiaries

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/beneficiaries");
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"},
        "Challenge": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch the account's beneficiaries

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

Return the beneficiaries of this account.

Parameters

Parameter	Description
unmasked in: query	boolean When requesting an account's beneficiaries, the full tax ID 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 tax ID. Such requests are auditable. default: false
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
Challenge in: header	challengeToken This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type. minLength: 6 maxLength: 255 pattern: "^[-_:.~%$a-zA-Z0-9]{6,255}$"

Example responses

200 Response

{
  "allocationPolicy": "percentage",
  "maximumBeneficiaries": 20,
  "items": [
    {
      "type": "organization",
      "percent": 10,
      "organization": {
        "type": "nonProfit",
        "legalName": "Doctors Without Borders USA",
        "taxId": "101010101",
        "primaryPhoneNumber": "+19105550155",
        "primaryEmail": "test@example.com",
        "primaryAddress": {
          "address1": "40 Rector St.",
          "address2": "16th Floor",
          "locality": "New York",
          "regionCode": "NY",
          "countryCode": "US",
          "postalCode": "10006"
        }
      }
    },
    {
      "type": "individual",
      "percent": 34.5,
      "individual": {
        "firstName": "Bobby",
        "lastName": "Tables",
        "taxId": "111111111",
        "birthdate": "1989-03-07",
        "relationship": "Child",
        "primaryPhoneNumber": "+19109204118",
        "primaryEmail": "test1@example.com",
        "primaryAddress": {
          "address1": "516 Cloud Drive",
          "locality": "Wilmington",
          "regionCode": "NC",
          "countryCode": "US",
          "postalCode": "28412"
        }
      }
    },
    {
      "type": "individual",
      "percent": 55.5,
      "individual": {
        "firstName": "Johnny",
        "lastName": "Tables",
        "taxId": "222222222",
        "birthdate": "1990-02-01",
        "relationship": "Child",
        "primaryPhoneNumber": "+19183920392",
        "primaryEmail": "test2@example.com",
        "primaryAddress": {
          "address1": "123 Maple Lane",
          "locality": "Wilmington",
          "regionCode": "NC",
          "countryCode": "US",
          "postalCode": "28412"
        }
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchBeneficiaries

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/banking/accounts/{accountId}/beneficiaries \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Challenge: string' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/banking/accounts/{accountId}/beneficiaries HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Challenge: string

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    {
      "percent": 15
    },
    {
      "percent": 29.5
    },
    {
      "individual": {
        "firstName": "Johnny",
        "lastName": "Tables",
        "birthdate": "1990-02-01",
        "relationship": "Child",
        "primaryEmail": "test2@example.com",
        "primaryAddress": {
          "address1": "123 Maple Lane",
          "locality": "Wilmington",
          "regionCode": "NC",
          "countryCode": "US",
          "postalCode": "28412"
        }
      }
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/beneficiaries',
{
  method: 'PATCH',
  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',
  'Challenge':'string',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/beneficiaries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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"},
        "Challenge": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Create or update the account's beneficiaries

PATCH https://api.apiture.com/banking/accounts/{accountId}/beneficiaries

Create or update the array of the beneficiaries for this account.

When updating an existing set of beneficiaries, empty objects in the items array or omitted objects inside the items are ignored. For example, the client may omit the individual and organization properties in the items array in order to adjust just the percentages:

  [ { 'percent': 12.5 },
    { 'percent': 30 },
    { 'percent': 20 },
    {},
    {}
  ]

will change just the percent of the first three beneficiaries and not update the other data for any of the five beneficiaries.

In order to delete a beneficiary, pass a null in place of that object. For example, if there were five beneficiaries and you wish to delete the third beneficiary and adjust the allocations of the remaining four beneficiaries to 50%, 20%, 20% and 10% respectively, use a request body:

  [ {'percent': 50},
    {'percent': 20},
    null,
    {'percent': 20},
    {'percent': 10}
  ]

The sum of percentages of the remaining beneficiaries must be adjusted to total 100.00% if allocationPolicy is percentage.

This operation applies only to personal accounts.

The 200 response indicates a full or partial success and includes details on any failed updates. The 204 response indicates that there were no changes to any beneficiaries. The 422 response indicates that all of the beneficiary updates failed.

Body parameter

{
  "items": [
    {
      "percent": 15
    },
    {
      "percent": 29.5
    },
    {
      "individual": {
        "firstName": "Johnny",
        "lastName": "Tables",
        "birthdate": "1990-02-01",
        "relationship": "Child",
        "primaryEmail": "test2@example.com",
        "primaryAddress": {
          "address1": "123 Maple Lane",
          "locality": "Wilmington",
          "regionCode": "NC",
          "countryCode": "US",
          "postalCode": "28412"
        }
      }
    }
  ]
}

Parameters

Parameter	Description
body	beneficiariesPatch Unevaluated Properties: false
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
Challenge in: header	challengeToken This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type. minLength: 6 maxLength: 255 pattern: "^[-_:.~%$a-zA-Z0-9]{6,255}$"

Example responses

200 Response

{
  "items": [
    {
      "previousBeneficiary": {},
      "beneficiaryPatch": "[Object]",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://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://api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Account Beneficial Owners

Account Beneficial Owners

listBeneficialOwners

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/beneficialOwners 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}/beneficialOwners',
{
  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}/beneficialOwners',
  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}/beneficialOwners',
  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}/beneficialOwners', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/beneficialOwners");
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}/beneficialOwners", data)
    req.Header = headers

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

List beneficial owners of an account

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

Return the beneficial owners for this account, including each owner's display name, ownership percentage, and owner type. Beneficial owners are parties with an ownership interest in the account. Beneficiaries are not beneficial owners and are not included in this response.

The ownership percentages in the response always sum to exactly 100%. If the source data does not sum to exactly 100%, the service adjusts the smallest necessary increment to produce an exact total, preserving the relative distribution. If the data cannot be normalized to a valid 100% distribution without violating constraints (such as producing a negative percentage), then the operation returns a 422 error.

If no beneficial owners are identified for the account, the response contains an empty items array.

The caller must have the allows.view permission for the account.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "name": "Max Pike",
      "ownershipPercentage": 100,
      "ownerType": "person"
    }
  ]
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Account Alerts

Account Alerts

getAccountAlertSubscriptions

Code samples

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

GET https://api.apiture.com/banking/accounts/{accountId}/alertSubscriptions 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}/alertSubscriptions',
{
  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}/alertSubscriptions',
  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}/alertSubscriptions',
  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}/alertSubscriptions', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/alertSubscriptions");
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}/alertSubscriptions", data)
    req.Header = headers

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

Return this account's alert subscriptions

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

Return alert subscriptions for this account. Each account maintains its own set of alert subscriptions. Allowed alert subscriptions may be limited by the account type.

Parameters

Parameter	Description
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "accountOverdrawn": {
    "enabled": true,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceUpdate": {
    "enabled": true,
    "interval": "weekly",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "debitTransactionLimit": {
    "enabled": true,
    "threshold": "100.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "creditTransactionLimit": {
    "enabled": true,
    "threshold": "1000.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceHigherThanLimit": {
    "enabled": true,
    "threshold": "10000.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceLowerThanLimit": {
    "enabled": true,
    "threshold": "10.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "checkClears": {
    "enabled": false,
    "checkNumbers": [
      "0123"
    ],
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "incomingWireConfirmed": {
    "enabled": false,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "outgoingWireConfirmed": {
    "enabled": false,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  }
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchAccountAlertSubscriptions

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/banking/accounts/{accountId}/alertSubscriptions \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/banking/accounts/{accountId}/alertSubscriptions HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "outgoingWireConfirmed": {
    "enabled": true,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/banking/accounts/{accountId}/alertSubscriptions',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/merge-patch+json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/merge-patch+json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/alertSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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/merge-patch+json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Update account alert subscriptions

PATCH https://api.apiture.com/banking/accounts/{accountId}/alertSubscriptions

Perform a partial update of this account's alert subscriptions as per JSON Merge Patch. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Body parameter

{
  "outgoingWireConfirmed": {
    "enabled": true,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  }
}

Parameters

Parameter	Description
body	accountAlertSubscriptionsPatch (required) The new account alert subscription. Unevaluated Properties: false
accountId in: path	resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "accountOverdrawn": {
    "enabled": true,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceUpdate": {
    "enabled": true,
    "interval": "weekly",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "debitTransactionLimit": {
    "enabled": true,
    "threshold": "100.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "creditTransactionLimit": {
    "enabled": true,
    "threshold": "1000.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceHigherThanLimit": {
    "enabled": true,
    "threshold": "10000.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceLowerThanLimit": {
    "enabled": true,
    "threshold": "10.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "checkClears": {
    "enabled": false,
    "checkNumbers": [
      "0123"
    ],
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "incomingWireConfirmed": {
    "enabled": false,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "outgoingWireConfirmed": {
    "enabled": false,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  }
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Schemas

account

{
  "id": "bf23bc970b78d27691e8",
  "nickname": "Payroll Checking",
  "label": "Payroll Checking *1008",
  "maskedNumber": "*1008",
  "product": {
    "type": "checking",
    "coreType": "DDA",
    "code": "DDA01",
    "label": "Business Checking",
    "allows": {
      "manuallyRefreshBalance": true
    }
  },
  "location": "internal",
  "jointOwnersCount": 0,
  "spendableBalanceAccount": true,
  "accountPastDue": false,
  "paymentDue": false,
  "state": "active",
  "allows": {
    "transferFrom": false,
    "transferTo": true,
    "billPay": false,
    "mobileCheckDeposit": true,
    "view": true,
    "viewCards": true,
    "manageCards": false,
    "viewLoanPayoffQuote": false,
    "realTimePaymentFrom": true,
    "realTimePaymentTo": true,
    "manageCdSettings": false,
    "manageCdProductSettings": false,
    "manageJointOwners": true,
    "manageOverdraftAccounts": true,
    "generateVerificationLetter": true,
    "viewInterestDisbursement": false,
    "manageInterestDisbursement": false,
    "viewElectronicDocuments": true,
    "viewElectronicStatements": true,
    "viewBeneficiaries": true,
    "manageBeneficiaries": true,
    "manageAccountAccess": true,
    "manageTransfers": true,
    "manageAlerts": true,
    "stopPayments": true,
    "viewImages": true,
    "manageDisputes": true,
    "editTransactions": true,
    "manuallyRefreshBalance": true,
    "orderDebitCard": false,
    "viewCollateral": false,
    "makePayment": false
  },
  "electronicStatements": true,
  "maximumJointOwners": 15,
  "owner": {
    "name": "Amanda Cummins"
  },
  "openedOn": "2026-03-10",
  "overdraft": {
    "protectionElections": {
      "primary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      },
      "secondary": {
        "election": false
      }
    },
    "limit": "100.00"
  }
}

Account (v20.2.0)

A customer's internal banking account.

Properties

Name	Description
Account (v20.2.0)	object A customer's internal banking account.
id	resourceId (required) The unique identifier for this account resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	accountLabel(text) (required) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. read-only format: text minLength: 1 maxLength: 80
nickname	accountNickname(text) 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. format: text maxLength: 50
maskedNumber	maskedAccountNumber (required) A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber. minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
fullAccountNumber	fullAccountNumber The full unmasked account number or member number. Note: This is omitted unless the request includes the ?unmasked=true query parameter. Such requests are auditable. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"
product	productItem (required) Details of one banking account in a collection of accounts. Unevaluated Properties: false
location	accountLocation (required) Indicates where an account is held. enum values: internal, external, outside, peer
jointOwnersCount	integer(int32) The number of joint owners for the account. format: int32 minimum: 0 maximum: 1000
spendableBalanceAccount	boolean (required) true if the account is a spendable balance account.
accountPastDue	boolean (required) true if the account has a balance that is past due.
paymentDue	boolean (required) true if the account has a payment due.
state	accountState (required) The state of the account. enum values: active, closed
allows	fullAccountPermissions 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.
electronicStatements	boolean (required) If true, the customer has opted in to receive account statements electronically.
cd	cdAccountSettings Certificate of Deposit properties for the account. This property is only present if the account.product.type is cd.
loan	loanAccountSettings Loan properties for the account. This property is only present if the account.product.type is loan. Unevaluated Properties: false
creditCard	creditCardAccountSettings Credit card properties for the account. This property is only present if the account.product.type is creditCard. Unevaluated Properties: false
ira	iraAccountSettings IRA properties for the account. This property is only present if the account.product.type is ira. Unevaluated Properties: false
maximumJointOwners	integer(int32) The maximum number of joint owners allowed for the account. Attempts to invite a new joint owner fail if the totalCount of joint owners is equal to this maximum. format: int32 minimum: 0 maximum: 1000
owner	accountOwnerCustomerReference The owner of the account.
openedOn	date(date) The date the account was opened, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10
closedOn	date(date) The date the account was closed, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10
overdraftProtectionElections	overdraftProtectionElections Warning: The property overdraftProtectionElections was deprecated on version v17.0.0 of the schema. Use the overdraft.protectionElections field instead. overdraftProtectionElections will be removed on version v25.0.0 of the schema. deprecated: true
overdraft	overdraftAccountSettings Overdraft properties for the account. This property is only present if the account.product.type is checking. Unevaluated Properties: false
interestRates	accountInterestRates The interest rates for the account. Unevaluated Properties: false
collateral	collateralAccountSettings Collateral properties for the account. This property is only present for secured accounts. Unevaluated Properties: false

accountAlertBalanceUpdateInterval

"daily"

Account Alert Balance Update Interval (v1.0.0)

Indicates how often the account holder receives a balance update.

accountAlertBalanceUpdateInterval strings may have one of the following enumerated values:

Value	Description
daily	Daily: The balance update alert is sent daily, including weekends and bank holidays.
weekly	Weekly: The balance update alert is sent weekly.
biweekly	Biweekly: The balance update alert is sent every two weeks.
monthly	Monthly: The balance update alert is sent monthly.

type: string

enum values: daily, weekly, biweekly, monthly

accountAlertClearedCheck

{
  "checkNumber": "1234",
  "clearedOn": "2025-08-25"
}

Account Alert Cleared Check (v1.0.1)

A cleared check.

Properties

Name	Description
Account Alert Cleared Check (v1.0.1)	object A cleared check. Unevaluated Properties: false
checkNumber	checkNumber (required) The check number. minLength: 1 maxLength: 16 pattern: "^[0-9]{1,16}$"
clearedOn	date(date) The date the check cleared, in YYYY-MM-DD RFC 3339 date UTC format. format: date minLength: 10 maxLength: 10

accountAlertCustomerCommunicationChannel

{
  "id": "0399abed-fd3d",
  "label": "Max.Pike@example.com",
  "type": "email"
}

Account Alert Customer Communication Channel (v1.0.2)

A customer's account alert communication channel.

Properties

Name	Description
Account Alert Customer Communication Channel (v1.0.2)	object A customer's account alert communication channel. Unevaluated Properties: false
id	resourceId (required) The identifier of this communication channel. This is derived and immutable. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	string(text) (required) A text representation of the communication channel. format: text minLength: 5 maxLength: 55
type	accountAlertCustomerCommunicationFactorType (required) The classification of this customer communication channel. enum values: email, sms

accountAlertCustomerCommunicationFactorType

"email"

Account Alert Customer Communication Factor Type (v1.0.0)

Identifier of the type of an account alert communication channel.

accountAlertCustomerCommunicationFactorType strings may have one of the following enumerated values:

Value	Description
email	Email: Communication delivered by email
sms	SMS: Communication delivered by SMS

type: string

enum values: email, sms

accountAlertMonetaryThreshold

"3456.78"

Account Alert Monetary Threshold (v1.0.0)

The monetary value of the threshold, supporting only positive dollar amounts without decimal (cents) values.

type: string(decimal)

format: decimal
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\.[0-9][0-9]$"
Unevaluated Properties: false

accountAlertProblem

{
  "type": "checksHaveAlreadyCleared",
  "title": "Checks Have Already Cleared",
  "detail": "One or more of the provided checks have already cleared and will not trigger an alert.",
  "attributes": {
    "clearedChecks": [
      {
        "checkNumber": "1234",
        "clearedOn": "2025-08-25"
      },
      {
        "checkNumber": "5678",
        "clearedOn": "2025-08-21"
      }
    ]
  }
}

Account Alert Problem (v1.0.1)

Describes a problem that did not prevent an account alert from being updated but may result in unexpected behavior.

Properties

Name	Description
Account Alert Problem (v1.0.1)	object Describes a problem that did not prevent an account alert from being updated but may result in unexpected behavior. Unevaluated Properties: false
type	accountAlertProblemType (required) The type of the problem. enum values: checksHaveAlreadyCleared
title	string(text) (required) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. format: text maxLength: 120
detail	string(text) (required) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
attributes	accountAlertProblemAttributes (required) Additional optional attributes related to the problem. Each object corresponds to each problem type in accountAlertProblemType. Unevaluated Properties: false

accountAlertProblemAttributes

{
  "clearedChecks": [
    {
      "checkNumber": "1234",
      "clearedOn": "2025-08-25"
    },
    {
      "checkNumber": "5678",
      "clearedOn": "2025-08-21"
    }
  ]
}

Account Alert Problem Attributes (v1.0.1)

Attributes relating to the problem. Each object corresponds to each problem type in accountAlertProblemType.

Properties

Name	Description
Account Alert Problem Attributes (v1.0.1)	object Attributes relating to the problem. Each object corresponds to each problem type in accountAlertProblemType. Unevaluated Properties: false
clearedChecks	array: [accountAlertClearedCheck] The check numbers that have already cleared. This is only set it problem[i].type is checksHaveAlreadyCleared. unique items minItems: 0 maxItems: 100 items: object » Unevaluated Properties: false

accountAlertProblemType

"checksHaveAlreadyCleared"

Account Alert Problem Type (v1.0.0)

The type of an account alert problem.

accountAlertProblemType strings may have one of the following enumerated values:

Value	Description
checksHaveAlreadyCleared	Checks Have Already Cleared: One or more of the provided checks have already cleared and will not trigger an alert.

type: string

enum values: checksHaveAlreadyCleared

accountAlertSubscriptions

{
  "accountOverdrawn": {
    "enabled": true,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceUpdate": {
    "enabled": true,
    "interval": "weekly",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "debitTransactionLimit": {
    "enabled": true,
    "threshold": "100.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "creditTransactionLimit": {
    "enabled": true,
    "threshold": "1000.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceHigherThanLimit": {
    "enabled": true,
    "threshold": "10000.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "balanceLowerThanLimit": {
    "enabled": true,
    "threshold": "10.00",
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "checkClears": {
    "enabled": false,
    "checkNumbers": [
      "0123"
    ],
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "incomingWireConfirmed": {
    "enabled": false,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  },
  "outgoingWireConfirmed": {
    "enabled": false,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  }
}

Account Alert Subscriptions (v1.0.2)

Representation of alert subscriptions for an account.

Properties

Name	Description
Account Alert Subscriptions (v1.0.2)	object Representation of alert subscriptions for an account. Unevaluated Properties: false
accountOverdrawn	simpleAccountAlertSubscription Alert the account holder that the account has been overdrawn. Unevaluated Properties: false
balanceUpdate	balanceUpdateAccountAlertSubscription Send an alert to the account holder at the specified interval with the account's balance. Unevaluated Properties: false
debitTransactionLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when a debit (outgoing) transaction exceeds this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
creditTransactionLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when a credit (deposit) exceeds this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
balanceHigherThanLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when the account's balance exceeds this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
balanceLowerThanLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when the account's balance is lower than this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
checkClears	checkClearsAccountAlertSubscription Alert the account holder when the specified check(s) clear(s). Unevaluated Properties: false
incomingWireConfirmed	simpleAccountAlertSubscription Alert the account holder when there is an incoming wire. Unevaluated Properties: false
outgoingWireConfirmed	simpleAccountAlertSubscription Alert the account holder when an outgoing wire has been confirmed. Unevaluated Properties: false
problems	array: [accountAlertProblem] A list of problems with the account alert settings that may result in unexpected behavior but which are not error conditions. maxItems: 100 items: object » Unevaluated Properties: false

accountAlertSubscriptionsPatch

{
  "outgoingWireConfirmed": {
    "enabled": true,
    "communicationChannels": [
      {
        "id": "0399abed-fd3d",
        "label": "Max.Pike@example.com",
        "type": "email"
      }
    ]
  }
}

Account Alert Subscriptions Patch (v1.0.2)

Representation used to patch account alert subscriptions using the JSON Merge Patch format and processing rules. Only included fields are updated on the resource; fields which are omitted are not updated.

Properties

Name	Description
Account Alert Subscriptions Patch (v1.0.2)	object Representation used to patch account alert subscriptions using the JSON Merge Patch format and processing rules. Only included fields are updated on the resource; fields which are omitted are not updated. Unevaluated Properties: false
accountOverdrawn	simpleAccountAlertSubscription Alert the account holder that the account has been overdrawn. Unevaluated Properties: false
balanceUpdate	balanceUpdateAccountAlertSubscription Send an alert to the account holder at the specified interval with the account's balance. Unevaluated Properties: false
debitTransactionLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when a debit (outgoing) transaction exceeds this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
creditTransactionLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when a credit (deposit) exceeds this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
balanceHigherThanLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when the account's balance exceeds this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
balanceLowerThanLimit	monetaryThresholdAccountAlertSubscription Alert the account holder when the account's balance is lower than this positive monetary amount in United States Dollars (USD). Unevaluated Properties: false
checkClears	checkClearsAccountAlertSubscription Alert the account holder when the specified check(s) clear(s). Unevaluated Properties: false
incomingWireConfirmed	simpleAccountAlertSubscription Alert the account holder when there is an incoming wire. Unevaluated Properties: false
outgoingWireConfirmed	simpleAccountAlertSubscription Alert the account holder when an outgoing wire has been confirmed. Unevaluated Properties: false

accountAllowsFilter

"billPay"

Account Allows Filter (v2.0.0)

Values for the ?allows= filter in listAccounts.

accountAllowsFilter strings may have one of the following enumerated values:

Value	Description
billPay	Bill Pay: Include each account where the caller is allowed to use the bill pay feature.
transferFrom	Transfer From: Include each account where the caller is allowed to transfer money from the account.
transferTo	Transfer To: Include each account where the caller is allowed to transfer money into the account.
mobileCheckDeposit	Mobile Check Deposit: Include each account where the caller is allowed to deposit mobile checks.
view	View: Include each account where the caller is allowed to view full account details (balances, full account number, transactions, etc).
viewCards	View Cards: Include each account where the caller is allowed to view debit card details.
manageCards	Manage Cards: Include each account where the caller is allowed to manage debit card details.
viewLoanPayoffQuote	View Loan Payoff Quote: Include each account where the caller is allowed to view a loan payoff quote.
manageOverdraftProtectionElections	Manage Overdraft Protection Elections: Include each account where the caller is allowed to manage overdraft protection plan elections.
realTimePaymentFrom	Real-Time Payments From: Include each account where the caller is allowed to send credit real-time payments.
realTimePaymentTo	Real-Time Payments To: Include each account where the caller is allowed to receive debit real-time payments.

type: string

enum values: billPay, transferFrom, transferTo, mobileCheckDeposit, view, viewCards, manageCards, viewLoanPayoffQuote, manageOverdraftProtectionElections, realTimePaymentFrom, realTimePaymentTo

accountBalance

{
  "id": "05d00d7d-d630",
  "available": "3208.20",
  "current": "3448.72",
  "computedBalanceDifference": "-240.52",
  "currentWithPending": "3448.72",
  "updatedAt": "2022-05-02T06:51:19.375Z",
  "incomplete": false,
  "primary": {
    "balance": "3208.20",
    "label": "Available",
    "description": "The amount of money available for use, typically the previous day's closing balance plus or minus any pending transactions"
  },
  "initialFunding": false,
  "interest": {
    "yearToDate": "284.32",
    "priorYear": "837.20",
    "accrued": "60.12"
  }
}

Account Balance (v1.7.2)

The balances of the given account.

If the primary balance is the current balance, then the secondary balance is the available balance, and if the primary balance is the available balance, then the secondary balance is the current balance. The fields primary.balanceand secondary.balance are required.

Properties

Name	Description
Account Balance (v1.7.2)	object The balances of the given account. If the primary balance is the current balance, then the secondary balance is the available balance, and if the primary balance is the available balance, then the secondary balance is the current balance. The fields primary.balanceand secondary.balance are required.
id	resourceId (required) The account ID. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
available	creditOrDebitValue(decimal) The available balance: the funds available for use. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
current	creditOrDebitValue(decimal) The current balance: the balance at the end of the previous business day. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
computedBalanceDifference	creditOrDebitValue(decimal) Computed difference between available and current balances (available - current) representing the net impact of pending or held activity on funds availability. This is the string representation of the exact decimal amount. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
collected	creditOrDebitValue(decimal) The available balance excluding deposited checks that have not yet cleared. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
sweep	creditOrDebitValue(decimal) The aggregate balance available for automatic transfer (sweeping) between accounts based on configured balance rules. Sweep operations move funds automatically when account balances cross specified thresholds, supporting various cash management strategies including overdraft protection, balance optimization, and liquidity management. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
updatedAt	readOnlyTimestamp(date-time) The time when the balance values were last updated from the banking core. read-only format: date-time minLength: 20 maxLength: 30
currentWithPending	creditOrDebitValue(decimal) The current balance, including pending transactions. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
incomplete	boolean (required) If true, the response is incomplete and the client may retry the operation after the Retry-After time in order to fetch balances for any incomplete accounts in the items. The retry operation should only pass in accounts that are incomplete.
paymentDue	paymentDue The payment due details on the account. This is excluded when the account type does not support payments, or when a payment is not due. Unevaluated Properties: false
paymentPastDue	paymentPastDue The payment past due details on the account. This is excluded when the account type does not support payments, or when the payment is not past due. Unevaluated Properties: false
automaticPayment	automaticPayment The automatic payment details for a credit/loan account. This is excluded when the account type does not support automatic payments, or when there is no automatic payment scheduled. Unevaluated Properties: false
initialFunding	boolean If true, the user can create an initial funding transfer to deposit funds into the account. default: false
interest	accountInterest The interest-related totals and disbursement details for the account. Unevaluated Properties: false
primary	primaryBalance The primary balance for the account. This could be either available or current balance depending on the product.type of the account. Unevaluated Properties: false
secondary	secondaryBalance The secondary balance for the account. This could be either available or current balance depending on the product.type of the account. Unevaluated Properties: false

accountBalances

{
  "items": [
    {
      "id": "05d00d7d-d630",
      "available": "3208.20",
      "current": "3448.72",
      "currentWithPending": "3448.72",
      "updatedAt": "2022-05-02T06:51:19.375Z",
      "incomplete": false,
      "primary": {
        "balance": "3208.20",
        "label": "Available",
        "description": "The amount of money available for use, typically the previous day's closing balance plus or minus any pending transactions"
      },
      "initialFunding": false,
      "interest": {
        "yearToDate": "284.32",
        "priorYear": "837.20",
        "accrued": "60.12"
      }
    },
    {
      "id": "cb5d67ea-a5c3",
      "available": "1750.80",
      "current": "1956.19",
      "currentWithPending": "1956.19",
      "updatedAt": "2022-05-02T06:51:19.375Z",
      "incomplete": false,
      "primary": {
        "balance": "1956.19",
        "label": "Current",
        "description": "Total account value including principal and earned interest"
      },
      "initialFunding": false,
      "interest": {
        "yearToDate": "102.44",
        "priorYear": "308.59",
        "accrued": "23.09"
      }
    }
  ]
}

Account Balances (v1.8.2)

An array of account balances by account ID.

Properties

Name	Description
Account Balances (v1.8.2)	object An array of account balances by account ID.
items	array: [accountBalance] (required) An array of items, one for each of the ?accounts= in the request, returned in the same order. maxItems: 10000 items: object

accountBeneficialOwner

{
  "name": "Max Pike",
  "ownershipPercentage": 60,
  "ownerType": "person"
}

Account Beneficial Owner (v1.0.0)

A beneficial owner of an account: a party with an ownership interest. Beneficiaries (such as payable-on-death beneficiaries) are not beneficial owners and are excluded from this resource.

Properties

Name	Description
Account Beneficial Owner (v1.0.0)	object A beneficial owner of an account: a party with an ownership interest. Beneficiaries (such as payable-on-death beneficiaries) are not beneficial owners and are excluded from this resource. Unevaluated Properties: false
name	string(text) (required) The display name of the beneficial owner. format: text maxLength: 100
ownershipPercentage	number(decimal) (required) The beneficial owner's ownership percentage of the account, greater than or equal to 0 and less than or equal to 100. The sum of all ownership percentages for a given account equals exactly 100. format: decimal minimum: 0 maximum: 100
ownerType	accountBeneficialOwnerType (required) The type of beneficial owner. This indicates whether the beneficial owner is an individual person or a business entity such as a corporation, LLC, or partnership. enum values: person, organization
ownerRole	string(text) A description of the ownership role (for example, Managing Member or Trustee). This is omitted if the ownership role is not known or available. format: text maxLength: 80

accountBeneficialOwnerType

"person"

Beneficial Owner Type (v1.0.0)

Indicates whether a beneficial owner is an individual person or a business entity such as a corporation, LLC, or partnership.

accountBeneficialOwnerType strings may have one of the following enumerated values:

Value	Description
person	Person: The beneficial owner is an individual person.
organization	Organization: The beneficial owner is an organization or business entity.

type: string

enum values: person, organization

accountBeneficialOwners

{
  "items": [
    {
      "name": "Max Pike",
      "ownershipPercentage": 100,
      "ownerType": "person"
    }
  ]
}

Account Beneficial Owner Collection (v1.0.0)

The collection of beneficial owners for an account. The ownership percentages in the items array sum to exactly 100% unless items is empty (no beneficial owners are identified for the account).

Properties

Name	Description
Account Beneficial Owner Collection (v1.0.0)	object The collection of beneficial owners for an account. The ownership percentages in the items array sum to exactly 100% unless items is empty (no beneficial owners are identified for the account). Unevaluated Properties: false
items	array: [accountBeneficialOwner] (required) The list of beneficial owners. May be empty if no beneficial owners are identified for the account. maxItems: 32 items: object » Unevaluated Properties: false

accountCollateralAssetSummary

{
  "cusipNumber": "303075105"
}

Account Collateral Asset Summary (v1.0.0)

Summary representation of an asset pledged as account collateral.

Properties

Name	Description
Account Collateral Asset Summary (v1.0.0)	object Summary representation of an asset pledged as account collateral. Unevaluated Properties: false
cusipNumber	cusipNumber (required) The unique Committee on Uniform Security Identification Procedures identifier assigned to all securities. minLength: 9 maxLength: 9 pattern: "^[a-zA-Z0-9]{9}$"

accountCollateralPledgeAmount

"3456.78"

Account Collateral Pledge Amount (v1.0.0)

The value assigned to this pledged asset for collateral purposes. Depending on the context and institution practices, this may represent different valuation bases, such as current market value (price x quantity), par (face) value, cost basis, book value, amortized cost, or an institution-defined collateral (pledge) value.

For collateralization, the most commonly used values are either the current market value or an adjusted valuation (e.g., collateral value or adjusted market value) where the institution applies internal rules, such as discounts ("haircuts"), to determine the amount of credit attributed to the asset.

type: string(decimal)

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

accountCollateralPledgeItem

{
  "asset": {
    "cusipNumber": "303075105"
  },
  "pledgeTerms": {
    "amount": "6293.41"
  }
}

Account Collateral Pledge Item (v1.0.0)

Summary representation of an individual asset pledged as collateral for an account. To fetch the full representation of this pledge, use the getAccountCollateralPledge operation, passing this item's cusipNumber field as the cusipNumber path parameter.

Properties

Name	Description
Account Collateral Pledge Item (v1.0.0)	object Summary representation of an individual asset pledged as collateral for an account. To fetch the full representation of this pledge, use the getAccountCollateralPledge operation, passing this item's cusipNumber field as the cusipNumber path parameter. Unevaluated Properties: false
asset	accountCollateralAssetSummary (required) Summary representation of an asset pledged as account collateral. Unevaluated Properties: false
pledgeTerms	accountCollateralPledgeTermsSummary (required) Summary representation of the terms of an account collateral pledge. Unevaluated Properties: false

accountCollateralPledgeTermsSummary

{
  "amount": "6293.41"
}

Account Collateral Pledge Terms Summary (v1.0.0)

Summary representation of the terms of an account collateral pledge.

Properties

Name	Description
Account Collateral Pledge Terms Summary (v1.0.0)	object Summary representation of the terms of an account collateral pledge. Unevaluated Properties: false
amount	accountCollateralPledgeAmount(decimal) (required) The value assigned to this pledged asset for collateral purposes. Depending on the context and institution practices, this may represent different valuation bases, such as current market value (price x quantity), par (face) value, cost basis, book value, amortized cost, or an institution-defined collateral (pledge) value. For collateralization, the most commonly used values are either the current market value or an adjusted valuation (e.g., collateral value or adjusted market value) where the institution applies internal rules, such as discounts ("haircuts"), to determine the amount of credit attributed to the asset. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"

accountIds

[
  "string"
]

Account IDs (v1.1.0)

An array of account IDs.

accountIds is an array schema.

Array Elements

type: array: [resourceId]

unique items
minItems: 1
maxItems: 1000

accountInterest

{
  "yearToDate": "284.32",
  "priorYear": "837.20",
  "accrued": "60.12"
}

Account Interest (v1.0.0)

Interest-related totals and disbursement details for an account.

Properties

Name	Description
Account Interest (v1.0.0)	object Interest-related totals and disbursement details for an account. Unevaluated Properties: false
yearToDate	monetaryValue(decimal) Total interest earned (for deposit accounts) or charged (for loan/credit accounts) for the account from the beginning of the current calendar year to date. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
priorYear	monetaryValue(decimal) Total interest earned (for deposit accounts) or charged (for loan/credit accounts) for the account during the previous calendar year. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
accrued	monetaryValue(decimal) Interest that has been accrued for the account but has not yet been paid (for deposit accounts) or posted (for loan/credit accounts). format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
disbursementTargetAccount	interestDisbursementTargetAccountReference The account designated to receive interest disbursements. This property only applies to deposit accounts. Unevaluated Properties: false

accountInterestRates

{
  "apr": "15.00",
  "cashAdvanceApr": "20.00"
}

Account Interest Rates (v1.0.0)

The interest rates for this account. The apy, apr and cashAdvanceApr values are decimal percentages, coded as strings in order to represent the rate exactly. Rates are coded to two decimal places. Rates are fixed, such { "apy" : "1.40" } for 1.40% APY.

Properties

Name	Description
Account Interest Rates (v1.0.0)	object The interest rates for this account. The apy, apr and cashAdvanceApr values are decimal percentages, coded as strings in order to represent the rate exactly. Rates are coded to two decimal places. Rates are fixed, such { "apy" : "1.40" } for 1.40% APY. Unevaluated Properties: false
apr	annualPercentageRate(decimal) The annual percentage rate (APR): the base interest rate as a percentage. format: decimal minLength: 4 maxLength: 7 pattern: "^(-|\\+)?(0|[1-9]\\d?)\\.\\d{2}$"
cashAdvanceApr	cashAdvanceAnnualPercentageRate(decimal) The cash advance annual percentage rate (APR): the interest rate charged for cash advances as a percentage. format: decimal minLength: 4 maxLength: 7 pattern: "^(-|\\+)?(0|[1-9]\\d?)\\.\\d{2}$"
apy	annualPercentageYield(decimal) The annual percentage yield (APY): the effective yield from interest, including compounding, as a percentage. Used on deposit account products. format: decimal minLength: 4 maxLength: 7 pattern: "^(-|\\+)?(0|[1-9]\\d?)\\.\\d{2}$"

accountItem

{
  "id": "bf23bc970b78d27691e8",
  "location": "internal",
  "nickname": "Payroll Checking",
  "label": "Payroll Checking *1008",
  "product": {
    "type": "checking",
    "coreType": "DDA",
    "code": "DDA01",
    "label": "Business Checking",
    "allows": {
      "manuallyRefreshBalance": true
    }
  },
  "maskedNumber": "*1008",
  "jointOwnersCount": 0,
  "spendableBalanceAccount": true,
  "accountPastDue": false,
  "paymentDue": false,
  "state": "active",
  "allows": {
    "transferFrom": false,
    "transferTo": true,
    "billPay": false,
    "mobileCheckDeposit": true,
    "view": true,
    "viewCards": true,
    "manageCards": true,
    "viewLoanPayoffQuote": false,
    "realTimePaymentFrom": true,
    "realTimePaymentTo": true,
    "manageCdSettings": false,
    "manageCdProductSettings": false
  }
}

Account Item (v8.1.0)

An account item in a list of items in the accounts schema.

Properties

Name	Description
Account Item (v8.1.0)	object An account item in a list of items in the accounts schema.
id	resourceId (required) The unique identifier for this account resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	accountLabel(text) (required) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. read-only format: text minLength: 1 maxLength: 80
nickname	accountNickname(text) 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. format: text maxLength: 50
maskedNumber	maskedAccountNumber (required) A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber. minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
fullAccountNumber	fullAccountNumber The full unmasked account number or member number. Note: This is omitted unless the request includes the ?unmasked=true query parameter. Such requests are auditable. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"
product	productItem (required) Details of one banking account in a collection of accounts. Unevaluated Properties: false
location	accountLocation (required) Indicates where an account is held. enum values: internal, external, outside, peer
jointOwnersCount	integer(int32) The number of joint owners for the account. format: int32 minimum: 0 maximum: 1000
spendableBalanceAccount	boolean (required) true if the account is a spendable balance account.
accountPastDue	boolean (required) true if the account has a balance that is past due.
paymentDue	boolean (required) true if the account has a payment due.
state	accountState (required) The state of the account. enum values: active, closed
allows	accountPermissions (required) 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.)
overdraftProtectionElections	overdraftProtectionElections Describes whether the account holder elected primary or secondary overdraft protection for the account and when those elections were last updated. Note: this property is only returned in account list items if the listAccounts request query parameter ?allows= includes manageOverdraftProtectionElections.

accountJointOwner

{
  "id": "0399abed-fd3d",
  "name": "Max Pike"
}

Account Joint Owner (v1.1.2)

Representation of account joint owner resources.

Properties

Name	Description
Account Joint Owner (v1.1.2)	object Representation of account joint owner resources.
id	resourceId (required) 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. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
name	string(text) (required) The full name of the joint owner. format: text maxLength: 50

accountJointOwners

{
  "items": [
    {
      "id": "db821618461ade2c5e45",
      "name": "Max Pike"
    },
    {
      "id": "1ef8f2bdfc729ea2b80b",
      "name": "Sam K. Pike"
    }
  ]
}

Account Joint Owner Collection (v1.3.0)

Collection of account joint owners. The items in the collection are ordered in the items array.

Properties

Name	Description
Account Joint Owner Collection (v1.3.0)	object Collection of account joint owners. The items in the collection are ordered in the items array.
items	array: [accountJointOwner] (required) An array containing account joint owner items. maxItems: 1000 items: object

accountLabel

"Checking *1008"

Account Label (v1.0.0)

The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber.

type: string(text)

format: text
minLength: 1
maxLength: 80

accountLabel1

"Checking *1008"

Account Label (v1.0.0)

The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber.

type: string(text)

format: text
minLength: 1
maxLength: 80

accountLocation

"internal"

Account Location (v1.1.0)

Indicates where an account is held

accountLocation strings may have one of the following enumerated values:

Value	Description
internal	Internal: Accounts held by the banking customer at the current financial institution.
external	External: Accounts held by the banking customer at another financial institution that are entitled for money movement.
outside	Outside: Accounts held by the banking customer at another financial institution that are not entitled for money movement.
peer	Peer: Accounts held by others at the same financial institution, for which the banking customer has transfer to and/or transfer from entitlements.

type: string

enum values: internal, external, outside, peer

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

accountOverdraftProtectionElectionUpdate

{
  "id": "4b350c7462d9722b94ef",
  "primary": true,
  "secondary": false
}

Account Overdraft Protection Election Update (v1.0.0)

Describes an account and whether the the authorized account holder wishes to enroll in the primary or secondary overdraft protection plan for that account. This operation does not change the primary or secondary plan elections for the account if the corresponding properties are omitted from the request body item.

Properties

Name	Description
Account Overdraft Protection Election Update (v1.0.0)	object Describes an account and whether the the authorized account holder wishes to enroll in the primary or secondary overdraft protection plan for that account. This operation does not change the primary or secondary plan elections for the account if the corresponding properties are omitted from the request body item.
id	resourceId (required) The id of an internal banking account (held at the financial institution). minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
primary	boolean true if the authorized user wishes to enable the financial institution's primary overdraft protection plan for this account; false to remove the the plan from this account. This property is honored if and only if the financial institution offers a secondary overdraft protection plan.
secondary	boolean true if the authorized user wishes to enable the financial institution's secondary overdraft protection plan for this account; false to remove the the plan from this account. This property is honored if and only if the financial institution offers a secondary overdraft protection plan.

accountOverdraftProtectionElections

{
  "id": "4b350c7462d9722b94ef",
  "primary": {
    "election": true,
    "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
  },
  "secondary": {
    "election": false,
    "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
  }
}

Account Overdraft Protection Elections (v1.0.0)

Indicates if the account holder has elected for an internal banking account referenced by id to be protected by the primary or secondary overdraft protection offered by the financial institution, and when those elections were last updated.

Properties

Name	Description
Account Overdraft Protection Elections (v1.0.0)	object Indicates if the account holder has elected for an internal banking account referenced by id to be protected by the primary or secondary overdraft protection offered by the financial institution, and when those elections were last updated.
id	resourceId (required) The id of an internal banking account (held at the financial institution). minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
primary	overdraftProtectionElection Whether the an account holder last elected for this account to be covered by the financial institution's primary overdraft protection plan. This value is only set if the financial institution offers a primary overdraft protection plan for the account.
secondary	overdraftProtectionElection Whether the an account holder last elected for this account to be covered by the financial institution's secondary overdraft protection plan. This value is only set if the financial institution offers a secondary overdraft protection plan.

accountOverdraftProtectionElectionsList

{
  "items": [
    {
      "id": "4b350c7462d9722b94ef",
      "primary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      },
      "secondary": {
        "election": false,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      }
    },
    {
      "id": "15de200607a00c8a2aef",
      "primary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      },
      "secondary": {
        "election": true,
        "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
      }
    }
  ]
}

Bulk Overdraft Protection Elections List (v1.0.0)

A list of Overdraft Protection Elections for one or more accounts.

Properties

Name	Description
Bulk Overdraft Protection Elections List (v1.0.0)	object A list of Overdraft Protection Elections for one or more accounts.
items	array: [accountOverdraftProtectionElections] (required) The list of account overdraft properties elections. minItems: 1 maxItems: 128 items: object

accountOwnerCustomerReference

{
  "name": "Amanda Cummins"
}

Account Owner Customer Reference (v1.0.0)

A reference to a customer who is the owner of the account. The name property is the customer's name at the time this reference was created.

Properties

Name	Description
Account Owner Customer Reference (v1.0.0)	object A reference to a customer who is the owner of the account. The name property is the customer's name at the time this reference was created.
name	string(text) (required) The customer's full name. format: text minLength: 1 maxLength: 50

accountPermissions

{
  "billPay": false,
  "mobileCheckDeposit": true,
  "transferFrom": true,
  "transferTo": true,
  "view": true,
  "viewCards": true,
  "manageCards": false,
  "viewLoanPayoffQuote": false,
  "realTimePaymentFrom": true,
  "realTimePaymentTo": true,
  "manageCdSettings": false,
  "manageCdProductSettings": false
}

Account Permissions (v4.0.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

Name	Description
Account Permissions (v4.0.0)	object 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.)
billPay	boolean (required) If true, the customer may use this account for Bill Pay.
mobileCheckDeposit	boolean (required) If true, the customer may use this account for mobile check deposits.
transferFrom	boolean (required) If true, the customer may use this account as the source (debit) account for account-to-account transfers.
transferTo	boolean (required) If true, the customer may use this account as the target (deposit) account for account-to-account transfers.
view	boolean (required) If true, the customer may view the details of this account, including the account balance and transactions.
viewCards	boolean (required) If true, the customer may view debit cards associated with this account.
manageCards	boolean (required) If true, the customer may manage debit cards associated with this account. This includes locking and unlocking cards, changing card controls, ordering cards, or canceling cards.
viewLoanPayoffQuote	boolean (required) If true, the customer may view a loan payoff quote for this account. Only valid for accounts where product.type is loan.
realTimePaymentFrom	boolean (required) If true, the customer may use this account to send credit real-time payments.
realTimePaymentTo	boolean (required) If true, the customer may use this account to receive debit real-time payments.
manageCdSettings	boolean (required) If true, the customer may manage CD settings for this account.
manageCdProductSettings	boolean (required) If true, the CD account is in the maturity grace period and is eligible for changing rollover settings.

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

accountState

"active"

Account State (v1.0.0)

Account state

accountState strings may have one of the following enumerated values:

Value	Description
active	Active: The account is active.
closed	Closed: The account is closed.

type: string

enum values: active, closed

accounts

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100?allows=view",
  "count": 6,
  "items": [
    {
      "id": "bf23bc970b78d27691e8",
      "nickname": "Payroll Checking",
      "label": "Payroll Checking *1008",
      "product": {
        "type": "checking",
        "coreType": "DDA",
        "code": "DDA01",
        "label": "Business Checking",
        "allows": {
          "manuallyRefreshBalance": true
        }
      },
      "maskedNumber": "*1008",
      "location": "internal",
      "jointOwnersCount": 0,
      "spendableBalanceAccount": true,
      "accountPastDue": false,
      "paymentDue": false,
      "state": "active",
      "allows": {
        "transferFrom": false,
        "transferTo": true,
        "billPay": false,
        "mobileCheckDeposit": true,
        "view": true,
        "viewCards": true,
        "manageCards": false,
        "viewLoanPayoffQuote": false,
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true,
        "manageCdSettings": false,
        "manageCdProductSettings": false
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    },
    {
      "id": "b78d27691e8bf23bc970",
      "nickname": "College CD",
      "label": "College CD *2017",
      "product": {
        "type": "cd",
        "code": "CDA",
        "coreType": "CD",
        "label": "24 Month CD",
        "allows": {
          "manuallyRefreshBalance": true
        }
      },
      "maskedNumber": "*2017",
      "location": "internal",
      "jointOwnersCount": 0,
      "spendableBalanceAccount": false,
      "accountPastDue": false,
      "paymentDue": false,
      "state": "active",
      "allows": {
        "transferFrom": false,
        "transferTo": false,
        "billPay": false,
        "mobileCheckDeposit": false,
        "view": true,
        "viewCards": true,
        "manageCards": false,
        "viewLoanPayoffQuote": false,
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true,
        "manageCdSettings": false,
        "manageCdProductSettings": false
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    }
  ]
}

Accounts (v8.1.0)

A paginated list of the customer's accounts. This list contains internal banking accounts and external banking accounts. and outside fund accounts. The location property indicates where the account is held. Items in the list contain url links to the actual account resource which are in the accounts, externalAccounts or outsideAccounts collections.

Properties

Name	Description
Accounts (v8.1.0)	object A paginated list of the customer's accounts. This list contains internal banking accounts and external banking accounts. and outside fund accounts. The location property indicates where the account is held. Items in the list contain url links to the actual account resource which are in the accounts, externalAccounts or outsideAccounts collections.
limit	integer(int32) (required) The number of items requested for this page response. The length of the items array may be less that limit. format: int32 minimum: 0 maximum: 10000
nextPage_url	string(uri-reference) The URL of the next page of accounts. If this URL is omitted, there are no more accounts. read-only format: uri-reference maxLength: 256
start	string(text) The opaque cursor that specifies the starting location of this page of items. format: text maxLength: 256
items	array: [accountItem] (required) The array of items in this page of accounts. This array may be empty. read-only maxItems: 1000 items: object
count	integer(int32) The total number of accounts for which the user has access. This value ignores any filters. This value is optional and may be omitted if the count is not computable efficiently. format: int32 minimum: 0 maximum: 25000
primaryAccountId	resourceId The id of the customer's primary account. This property only exists for retail customers, and only if the customer has designated a primary account. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

achSecCode

"arc"

ACH SEC Code (v1.0.0)

The ACH transfer type.

achSecCode strings may have one of the following enumerated values:

Value	Description
arc	Accounts Receivable
boc	Back Office Conversion
ccd	Credit or Debit
cie	Customer-Initiated
ctx	Corporate Trade Exchange
pop	Point of Purchase
ppd	Prearranged Payment and Deposit
rck	Re-Presented Check
tel	Telephone-initiated
web	Internet-initiated/Mobile

type: string

enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web

annualPercentageRate

"1.40"

Annual Percentage Rate (v1.0.0)

The annual percentage rate (APR): the base interest rate as a percentage.

type: string(decimal)

format: decimal
minLength: 4
maxLength: 7
pattern: "^(-|\+)?(0|[1-9]\d?)\.\d{2}$"

annualPercentageYield

"1.44"

Annual Percentage Yield (v1.0.0)

The annual percentage yield (APY): the effective yield from interest, including compounding, as a percentage. Used on deposit account products.

type: string(decimal)

format: decimal
minLength: 4
maxLength: 7
pattern: "^(-|\+)?(0|[1-9]\d?)\.\d{2}$"

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://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://api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.2)

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

Properties

Name	Description
API Problem (v1.2.2)	object API problem or error, as per RFC 7807 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object

automaticPayment

{
  "amount": "500.00",
  "paymentDueOn": "2025-04-01"
}

Automatic Payment (v1.0.2)

An automatic payment to a credit/loan account.

Properties

Name	Description
Automatic Payment (v1.0.2)	object An automatic payment to a credit/loan account. Unevaluated Properties: false
amount	creditOrDebitValue(decimal) (required) The net payment to apply to the account balance, as defined by the automatic payment settings for this account. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
paymentDueOn	date(date) (required) The scheduled date for the automatic payment, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10

balanceUpdateAccountAlertSubscription

{
  "enabled": true,
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "interval": "daily"
}

Balance Update Account Alert Subscription (v1.0.2)

Send an alert to the account holder at the specified interval with the account's balance.

Properties

Name	Description
Balance Update Account Alert Subscription (v1.0.2)	object Send an alert to the account holder at the specified interval with the account's balance. Unevaluated Properties: false
enabled	boolean (required) If true, the alert is enabled.
communicationChannels	array: [accountAlertCustomerCommunicationChannel] (required) Channels to communicate this alert subscription. unique items minItems: 0 maxItems: 5 items: object » Unevaluated Properties: false
interval	accountAlertBalanceUpdateInterval (required) How often the account holder should be updated with the account's balance. enum values: daily, weekly, biweekly, monthly

bankPeerAccount

{
  "maskedAccountNumber": "*6789",
  "fullAccountNumber": "123456789"
}

Bank Peer Account (v1.0.0)

A peer account for a bank financial institution.

Note: The full account number is omitted unless the request includes the ?unmasked=true query parameter.

Properties

Name	Description
Bank Peer Account (v1.0.0)	object A peer account for a bank financial institution. Note: The full account number is omitted unless the request includes the ?unmasked=true query parameter.
fullAccountNumber	fullAccountNumber A full account number. This is the number that the customer uses to reference the account within the financial institution. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"
maskedAccountNumber	maskedAccountNumber (required) A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber. minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"

bankPeerAccountReplacement

{
  "fullAccountNumber": "123456789"
}

New Bank Peer Account (v1.0.0)

Identifies a new peer account at a bank.

Properties

Name	Description
New Bank Peer Account (v1.0.0)	object Identifies a new peer account at a bank.
fullAccountNumber	fullAccountNumber A full account number. This is the number that the customer uses to reference the account within the financial institution. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"

bankingCustomerTaxId

"112-22-3333"

Banking Customer Tax Id (v1.0.0)

The customer's US social security number (SSN) or individual taxpayer ID number (ITIN), In responses, this value is masked (all but the last four digits are replaced with one or more asterisks *). Use ?unmasked=true to include the full taxId in responses. Unmasked responses exclude formatting hyphens (NNNNNNNNN format). In requests, up to two hyphens are allowed (NNN-NN-NNNN format).

type: string(text)

format: text
minLength: 9
maxLength: 11

bankingOrganizationTaxId

"string"

• (v2.0.0)*

The tax identification number (TIN) or Employer Identification Number (EIN) of the business/organization. Note: If the organization is a sole proprietorship, the taxId is the proprietor's social security number. For security purposes, this value may be masked in responses. Use the ?unmasked=true query parameter to request that the response include unmasked data.

type: string(text)

format: text
minLength: 5
maxLength: 11

bankingProductItem

{
  "id": "9d8f45ef9be307e1405d",
  "customerType": "personal",
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "180-day Certificate of Deposit account that earns 1.60%",
  "primaryHighlights": [
    "High APY of {depositRates.apy}%",
    "No monthly fees if minimum balance of ${constraints.minimumBalance} is maintained."
  ],
  "secondaryHighlights": [
    "Optional electronic delivery of monthly statements"
  ],
  "allows": {
    "manuallyRefreshBalance": true
  }
}

Product Item (v2.0.1)

Summary representation of a product resource in products collections. To fetch the full representation of this product, use the getBankingProduct operation, passing this item's id field as the bankingProductId path parameter.

Properties

Name	Description
Product Item (v2.0.1)	object Summary representation of a product resource in products collections. To fetch the full representation of this product, use the getBankingProduct operation, passing this item's id field as the bankingProductId path parameter.
type	productType (required) The type of account. enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings, other
coreType	string (required) The account product type in the banking core. For example, some cores may use "D" for a demand deposit (checking) account, some may use "DDA". minLength: 1 maxLength: 4 pattern: "^[A-Z0-9]{1,4}$"
code	string(text) (required) The product's product code which uniquely identifies the product from other banking products. Codes are unique to the financial institution. For example, different products with the same type and the same coreType but different rates or other properties have different product codes, such as CD3M, DDA_HI_YLD, P3207. format: text minLength: 1 maxLength: 16
label	string(text) (required) A human-readable label for this banking product. format: text minLength: 2 maxLength: 48
description	string(markdown) A human-readable description of this banking product. format: markdown minLength: 2 maxLength: 400
id	resourceId (required) The unique identifier for this product resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
customerType	productCustomerType (required) Describes the target audience or consumer of the accounts, personal or business. Labels and descriptions for the enumeration values are in the productTarget key in the response of the getLabels operation. enum values: personal, business, both
primaryHighlights	array: [string] A list of descriptive strings which highlight attributes of the product, to be presented to the end users in the product details. The strings may include these product property references: {depositRates.apy} {depositRates.apr} {depositRates.accrualType} Note: The corresponding values are inserted into these primaryHighlights and secondaryHighlights strings only when the ?resolve=true option is used on the getBankingProduct call. maxItems: 16 items: string(text) » format: text » maxLength: 512
secondaryHighlights	array: [string] A list of descriptive strings which highlight secondary attributes of the product, to be presented to the end users in the product details. The strings may include these product property as described for primaryHighlights. maxItems: 16 items: string(template) » format: template » maxLength: 512
allows	productAllows (required) Indicates what actions are allowed for the product type.

bankingProductReference

{
  "type": "savings",
  "coreType": "stri",
  "code": "CD001",
  "label": "string",
  "description": "string",
  "id": "string"
}

Banking Product Reference (v1.0.1)

A reference to a banking product for use in create or patch schemas.

Properties

Name	Description
Banking Product Reference (v1.0.1)	object A reference to a banking product for use in create or patch schemas. Unevaluated Properties: false
type	productType The type of account. enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings, other
coreType	string The account product type in the banking core. For example, some cores may use "D" for a demand deposit (checking) account, some may use "DDA". minLength: 1 maxLength: 4 pattern: "^[A-Z0-9]{1,4}$"
code	string(text) The product's product code which uniquely identifies the product from other banking products. Codes are unique to the financial institution. For example, different products with the same type and the same coreType but different rates or other properties have different product codes, such as CD3M, DDA_HI_YLD, P3207. format: text minLength: 1 maxLength: 16
label	string(text) A human-readable label for this banking product. format: text minLength: 2 maxLength: 48
description	string(markdown) A human-readable description of this banking product. format: markdown minLength: 2 maxLength: 400
id	resourceId (required) The unique identifier for this product resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

bankingProducts

{
  "items": [
    {
      "id": "3c1fecca79d826f86a6b",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "30D_CDA",
      "label": "30 Day CD",
      "description": "30-day Certificate of Deposit account that earns 1.50%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "97321f98fece14faa978",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "90D_CDA",
      "label": "90 Day CD",
      "description": "90-day Certificate of Deposit account that earns 1.55%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "3545997133afaf3dcd30",
      "type": "cd",
      "customerType": "personal",
      "coreType": "CD",
      "code": "180D_CDA",
      "label": "180 Day CD",
      "description": "180-day Certificate of Deposit account that earns 1.60%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    },
    {
      "id": "37fcd855d7873549584d",
      "type": "savings",
      "customerType": "personal",
      "coreType": "SAV",
      "code": "SAV_01",
      "label": "Basic Savings",
      "description": "Basic savings account that earns 0.15%",
      "allows": {
        "manuallyRefreshBalance": true
      }
    }
  ]
}

Banking Product Collection (v2.0.1)

Collection of banking products offered by the financial institution.

Properties

Name	Description
Banking Product Collection (v2.0.1)	object Collection of banking products offered by the financial institution.
items	array: [bankingProductItem] (required) An array containing the banking product items. maxItems: 10000 items: object

beneficiaries

{
  "allocationPolicy": "percentage",
  "maximumBeneficiaries": 20,
  "items": [
    {
      "type": "organization",
      "percent": 10,
      "organization": {
        "type": "nonProfit",
        "legalName": "Doctors Without Borders USA",
        "taxId": "101010101",
        "primaryPhoneNumber": "+19105550155",
        "primaryEmail": "test@example.com",
        "primaryAddress": {
          "address1": "40 Rector St.",
          "address2": "16th Floor",
          "locality": "New York",
          "regionCode": "NY",
          "countryCode": "US",
          "postalCode": "10006"
        }
      }
    },
    {
      "type": "individual",
      "percent": 34.5,
      "individual": {
        "firstName": "Bobby",
        "lastName": "Tables",
        "taxId": "111111111",
        "birthdate": "1989-03-07",
        "relationship": "Child",
        "primaryPhoneNumber": "+19109204118",
        "primaryEmail": "test1@example.com",
        "primaryAddress": {
          "address1": "516 Cloud Drive",
          "locality": "Wilmington",
          "regionCode": "NC",
          "countryCode": "US",
          "postalCode": "28412"
        }
      }
    },
    {
      "type": "individual",
      "percent": 55.5,
      "individual": {
        "firstName": "Johnny",
        "lastName": "Tables",
        "taxId": "222222222",
        "birthdate": "1990-02-01",
        "relationship": "Child",
        "primaryPhoneNumber": "+19183920392",
        "primaryEmail": "test2@example.com",
        "primaryAddress": {
          "address1": "123 Maple Lane",
          "locality": "Wilmington",
          "regionCode": "NC",
          "countryCode": "US",
          "postalCode": "28412"
        }
      }
    }
  ]
}

Beneficiaries (v5.0.1)

Account beneficiaries who received the account assets if the owner dies. Beneficiaries apply only to personal accounts. The allocationPolicy determines how the funds are allocated, either equal (all n beneficiaries get an even 1/n allocation) or percentage, where the percent values in this array (rounded down to the nearest 0.01) must add up to 100.00 exactly.

Properties

Name	Description
Beneficiaries (v5.0.1)	object Account beneficiaries who received the account assets if the owner dies. Beneficiaries apply only to personal accounts. The allocationPolicy determines how the funds are allocated, either equal (all n beneficiaries get an even 1/n allocation) or percentage, where the percent values in this array (rounded down to the nearest 0.01) must add up to 100.00 exactly. Unevaluated Properties: false
allocationPolicy	beneficiaryAllocationPolicyType The policy the financial institution uses for managing allocations for beneficiaries. beneficiaryAllocationPolicyType strings may have one of the following enumerated values: Value Description equal Equal: All beneficiaries get an even allocation. percentage Percentage: The percent values in this array (rounded down to the nearest 0.01) must add up to 100.00 exactly. enum values: equal, percentage
maximumBeneficiaries	integer(int32) The maximum number of beneficiaries allowed to be created for this account. This is configurable by the financial institution. format: int32 maximum: 20
items	array: [beneficiaryItem] A list of beneficiaries who receive the account assets payable on death (POD) of the account owner(s). This array may be empty. The maximum number of account beneficiaries is configurable by the financial institution. Beneficiaries are updated via the patchBeneficiaries operation. maxItems: 20 items: object » Unevaluated Properties: false

beneficiariesPatch

{
  "items": [
    {
      "percent": 15
    },
    {
      "percent": 29.5
    },
    {
      "individual": {
        "firstName": "Johnny",
        "lastName": "Tables",
        "birthdate": "1990-02-01",
        "relationship": "Child",
        "primaryEmail": "test2@example.com",
        "primaryAddress": {
          "address1": "123 Maple Lane",
          "locality": "Wilmington",
          "regionCode": "NC",
          "countryCode": "US",
          "postalCode": "28412"
        }
      }
    }
  ]
}

Beneficiaries Patch (v5.0.1)

Represents a patch to the account beneficiaries.

Properties

Name	Description
Beneficiaries Patch (v5.0.1)	object Represents a patch to the account beneficiaries. Unevaluated Properties: false
items	array: array A list of beneficiaries who are being patched. The maximum number of account beneficiaries is configurable by the financial institution. maxItems: 20
» Beneficiary Patch Item (v5.0.1)	beneficiaryPatchItem | null An account beneficiary item in a list of items in the beneficiaries schema. Each beneficiary receives a percentage of the account assets if the personal account owner dies. A beneficiary is either a person or a business organization representing a trust or charity/non-profit. nullable Unevaluated Properties: false

beneficiaryAllocationPolicyType

"equal"

Beneficiary Allocation Policy Type (v1.0.0)

The policy the financial institution uses for managing allocations for beneficiaries.

beneficiaryAllocationPolicyType strings may have one of the following enumerated values:

Value	Description
equal	Equal: All beneficiaries get an even allocation.
percentage	Percentage: The percent values in this array (rounded down to the nearest 0.01) must add up to 100.00 exactly.

type: string

enum values: equal, percentage

beneficiaryItem

{
  "type": "organization",
  "percent": 10,
  "organization": {
    "type": "nonProfit",
    "legalName": "Doctors Without Borders USA",
    "taxId": "111111111",
    "primaryPhoneNumber": "+19105550155",
    "primaryEmail": "test@example.com",
    "primaryAddress": {
      "address1": "40 Rector St.",
      "address2": "16th Floor",
      "locality": "New York",
      "regionCode": "NY",
      "countryCode": "US",
      "postalCode": "10006"
    }
  }
}

Beneficiary Item (v5.0.1)

An account beneficiary item in a list of items in the beneficiaries schema. Each beneficiary receives a percentage of the account assets if the personal account owner dies. A beneficiary is either a person or a business organization representing a trust or charity/non-profit.

Properties

Name	Description
Beneficiary Item (v5.0.1)	object An account beneficiary item in a list of items in the beneficiaries schema. Each beneficiary receives a percentage of the account assets if the personal account owner dies. A beneficiary is either a person or a business organization representing a trust or charity/non-profit. Unevaluated Properties: false
type	beneficiaryType (required) Indicates if this beneficiary is a business organization or an individual person. beneficiaryType strings may have one of the following enumerated values: Value Description individual Individual: The beneficiary is an individual person. organization Organization: The beneficiary is a business organization representing a trust or charity. enum values: individual, organization
individual	individualBeneficiaryResponse Details of a beneficiary who is an individual person. The individual property is only used if type is individual and is thus mutually exclusive with organization. Unevaluated Properties: false
organization	organizationBeneficiary Details of a trust or charity/non-profit beneficiary. The organization property is only used if type is organization and is thus mutually exclusive with individual. Unevaluated Properties: false
percent	number The percent of the account assets that this beneficiary should receive, expressed as a decimal number, rounded down to the nearest 0.01. For example, the values 33.3333 and 33.3399 become 33.33%. This property is ignored if allocationPolicy is equal in account.beneficiaries. minimum: 0.01 maximum: 100

beneficiaryOrganizationType

"trust"

Beneficiary Organization Type (v1.0.0)

The type of the beneficiary organization.

beneficiaryOrganizationType strings may have one of the following enumerated values:

Value	Description
trust	Trust: The beneficiary organization is a trust.
nonProfit	Non-Profit: The beneficiary organization is a charity or non-profit.

type: string

enum values: trust, nonProfit

beneficiaryPatchItem

{
  "percent": 15
}

Beneficiary Patch Item (v5.0.1)

An account beneficiary item in a list of items in the beneficiaries schema. Each beneficiary receives a percentage of the account assets if the personal account owner dies. A beneficiary is either a person or a business organization representing a trust or charity/non-profit.

Properties

Name	Description
Beneficiary Patch Item (v5.0.1)	object | null An account beneficiary item in a list of items in the beneficiaries schema. Each beneficiary receives a percentage of the account assets if the personal account owner dies. A beneficiary is either a person or a business organization representing a trust or charity/non-profit. nullable Unevaluated Properties: false
type	beneficiaryType The type of beneficiary: either an individual person or an organization. If the beneficiary type is being updated, this field is required. enum values: individual, organization
individual	nullableIndividualBeneficiaryRequest | null Details of a beneficiary who is an individual person. The individual property is only used if type is individual and is thus mutually exclusive with organization. nullable Unevaluated Properties: false
organization	nullableOrganizationBeneficiaryRequest | null Details of a trust or charity/non-profit beneficiary. The organization property is only used if type is organization and is thus mutually exclusive with individual. nullable Unevaluated Properties: false
percent	number The percent of the account assets that this beneficiary should receive, expressed as a decimal number, rounded down to the nearest 0.01. For example, the values 33.3333 and 33.3399 become 33.33%. This property is ignored if allocationPolicy is equal in account.beneficiaries. minimum: 0.01 maximum: 100

beneficiaryType

"individual"

Beneficiary Type (v1.0.0)

Indicates if this beneficiary is a business organization or an individual person.

beneficiaryType strings may have one of the following enumerated values:

Value	Description
individual	Individual: The beneficiary is an individual person.
organization	Organization: The beneficiary is a business organization representing a trust or charity.

type: string

enum values: individual, organization

beneficiaryUpdateResponse

{
  "items": [
    {
      "previousBeneficiary": {},
      "beneficiaryPatch": "[Object]",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://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://api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Beneficiary Update Response (v5.0.1)

Beneficiary update response.

Properties

Name	Description
Beneficiary Update Response (v5.0.1)	object Beneficiary update response. Unevaluated Properties: false
items	array: [allOf] (required) The result of attempting to update a set of beneficiaries in the request. Items in the array correspond (in order) to each beneficiary in the request. minItems: 1 maxItems: 999 items:
» Beneficiary Update Response Item (v5.0.1)	beneficiaryUpdateResponseItem The result of attempting to perform an action on one beneficiary from the list of beneficiaries in the request. Unevaluated Properties: false

beneficiaryUpdateResponseItem

{
  "previousBeneficiary": {
    "type": "organization",
    "percent": 10,
    "organization": {
      "type": "nonProfit",
      "legalName": "Doctors Without Borders USA",
      "taxId": "111111111",
      "primaryPhoneNumber": "+19105550155",
      "primaryEmail": "test@example.com",
      "primaryAddress": {
        "address1": "40 Rector St.",
        "address2": "16th Floor",
        "locality": "New York",
        "regionCode": "NY",
        "countryCode": "US",
        "postalCode": "10006"
      }
    }
  },
  "beneficiaryPatch": {
    "percent": 15
  },
  "succeeded": true,
  "problems": [
    {
      "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
      "type": "https://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://api.apiture.com/banking/transfers/bb709151-575041fcd617"
    }
  ]
}

Beneficiary Update Response Item (v5.0.1)

An item in a beneficiary update response.

Properties

Name	Description
Beneficiary Update Response Item (v5.0.1)	object An item in a beneficiary update response. Unevaluated Properties: false
previousBeneficiary	beneficiaryItem The previous state of the updated beneficiary. Unevaluated Properties: false
beneficiaryPatch	beneficiaryPatchItem | null (required) The attempted update of the beneficiary. nullable Unevaluated Properties: false
succeeded	boolean (required) true if the operation was successful for the beneficiary.
problems	array: [apiProblem] If the operation for this beneficiary failed (succeeded is false), this describes why. This may include forbidden, conflict, or other 4xx error or problem types that can occur with individual beneficiary calls. maxItems: 1000 items: object

beneficiaryUpdates

{
  "items": [
    {
      "previousBeneficiary": {},
      "beneficiaryPatch": "[Object]",
      "succeeded": true,
      "problems": [
        {
          "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
          "type": "https://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://api.apiture.com/banking/transfers/bb709151-575041fcd617"
        }
      ]
    }
  ]
}

Beneficiary Updates (v5.0.1)

Response from the request to update a set of beneficiaries.

Properties

Name	Description
Beneficiary Updates (v5.0.1)	object Response from the request to update a set of beneficiaries.
items	array: [allOf] (required) The result of attempting to update a set of beneficiaries in the request. Items in the array correspond (in order) to each beneficiary in the request. minItems: 1 maxItems: 999 items:
» Beneficiary Update Response Item (v5.0.1)	beneficiaryUpdateResponseItem The result of attempting to perform an action on one beneficiary from the list of beneficiaries in the request. Unevaluated Properties: false

bulkAccountOverdraftProtectionElectionsUpdate

{
  "items": [
    {
      "id": "4b350c7462d9722b94ef",
      "primary": true,
      "secondary": true
    },
    {
      "id": "15de200607a00c8a2aef",
      "primary": false,
      "secondary": false
    }
  ]
}

Bulk Overdraft Protection Elections Update (v1.0.0)

A request to change the overdraft protection elections for one or more accounts.

Properties

Name	Description
Bulk Overdraft Protection Elections Update (v1.0.0)	object A request to change the overdraft protection elections for one or more accounts.
items	array: [accountOverdraftProtectionElectionUpdate] (required) The overdraft protection plan elections to change, one for for each account. minItems: 1 maxItems: 128 items: object

cashAdvanceAnnualPercentageRate

"1.40"

Cash Advance Annual Percentage Rate (v1.0.0)

The cash advance annual percentage rate (APR): the interest rate charged for cash advances as a percentage.

type: string(decimal)

format: decimal
minLength: 4
maxLength: 7
pattern: "^(-|\+)?(0|[1-9]\d?)\.\d{2}$"

cdAccountMaturityPolicy

"rolloverPrincipalAndInterest"

CD Account Maturity Policy (v1.0.0)

Indicates how the principal and interest are processed upon this account's maturity. The values indicate whether to rollover to a CD account of the same rate and term, transfer funds to another (possibly new) deposit account, or simply hold the funds in the current account (which may no longer accrue interest). Labels and descriptions for the enumeration values are in the maturityPolicy key in the response of the getLabels operation.

cdAccountMaturityPolicy strings may have one of the following enumerated values:

Value	Description
rolloverPrincipalAndInterest	Rollover principal and interest: Both principal and interest rollover into a CD of the same CD banking product and same term.
transferPrincipalAndInterest	Transfer principal and interest to a deposit account: The principal and interest are both transferred to a new or existing deposit account.
rolloverPrincipalAndTransferInterest	Rollover principal and transfer interest: The principal rolls over into the same CD banking product and the interest is transferred to new or a existing deposit account.
holdPrincipalAndInterest	Hold principal and accrued interest in the CD account until withdrawal: The principal and interest are held in the current CD account. The account may or may not accrue further interest, depending on the terms of the CD banking product. Funds may be withdrawn or transferred.
partialTransfer	Partial Transfer: Any funds greater than the maturity threshold are transferred to an existing deposit account and the rest remains on deposit. The account may or may not accrue further interest, depending on the terms of the CD banking product. Funds may be withdrawn or transferred.

type: string

enum values: rolloverPrincipalAndInterest, transferPrincipalAndInterest, rolloverPrincipalAndTransferInterest, holdPrincipalAndInterest, partialTransfer

cdAccountMaturityRequest

{
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  }
}

CD Account Maturity Request (v1.0.0)

The request body to apply CD maturity settings upon maturity of a CD account during the maturity grace period.

Properties

Name	Description
CD Account Maturity Request (v1.0.0)	object The request body to apply CD maturity settings upon maturity of a CD account during the maturity grace period. Unevaluated Properties: false
maturityPolicy	cdAccountMaturityPolicy What happens to the funds in the account upon maturity. enum values: rolloverPrincipalAndInterest, transferPrincipalAndInterest, rolloverPrincipalAndTransferInterest, holdPrincipalAndInterest, partialTransfer
rolloverProduct	bankingProductReference The CD banking product to roll this account to, if the maturityPolicy indicates a rollover. The default is the same CD banking product. Eligible products are listed in the listEligibleCdRolloverProducts operation. Unevaluated Properties: false
transferAccount	cdMaturityTransferAccount The existing internal or external account where interest and/or balance are transferred at CD maturity if maturityPolicy is transferPrincipalAndInterest or rolloverPrincipalAndTransferInterest. The account must have transferTo entitlements for the account holder. transferAccount and transferProduct are mutually exclusive.
transferProduct	bankingProductReference The banking product for a new account where interest and/or balance are transferred at CD maturity, if maturityPolicy is transferPrincipalAndInterest or rolloverPrincipalAndTransferInterest. transferAccount and transferProduct are mutually exclusive. Unevaluated Properties: false

cdAccountProduct

{
  "product": {
    "id": "6fbe55ebe9f78b61a0ab",
    "type": "cd",
    "coreType": "CD",
    "label": "1 Year High Yield CD"
  }
}

CD Account Product (v1.0.0)

The banking product for the current CD and for automatic rollover at future maturities.

Properties

Name	Description
CD Account Product (v1.0.0)	object The banking product for the current CD and for automatic rollover at future maturities. Unevaluated Properties: false
product	bankingProductReference (required) The CD banking product for the current CD and for automatic rollover at future maturities. Eligible products are listed in the listEligibleCdRolloverProducts operation. Unevaluated Properties: false

cdAccountSettings

{
  "maturesAt": "2023-10-30T08:00:00.000Z",
  "term": "P6M",
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  },
  "inDebitGracePeriod": true,
  "inCreditGracePeriod": true,
  "debitGracePeriodStartsOn": "2023-11-01",
  "creditGracePeriodStartsOn": "2023-11-01",
  "debitGracePeriodEndsOn": "2023-11-11",
  "creditGracePeriodEndsOn": "2023-11-11"
}

CD Account Settings (v3.0.2)

Settings for Certificate of Deposit (CD) accounts.

Properties

Name	Description
CD Account Settings (v3.0.2)	object Settings for Certificate of Deposit (CD) accounts.
maturityPolicy	cdAccountMaturityPolicy (required) What happens to the funds in the account upon maturity. enum values: rolloverPrincipalAndInterest, transferPrincipalAndInterest, rolloverPrincipalAndTransferInterest, holdPrincipalAndInterest, partialTransfer
rolloverProduct	bankingProductReference The CD banking product to roll this account to, if the maturityPolicy indicates a rollover. The default is the same CD banking product. Eligible products are listed in the listEligibleCdRolloverProducts operation. Unevaluated Properties: false
transferAccount	cdMaturityTransferAccount The existing internal or external account where interest and/or balance are transferred at CD maturity if maturityPolicy is transferPrincipalAndInterest or rolloverPrincipalAndTransferInterest. The account must have transferTo entitlements for the account holder. transferAccount and transferProduct are mutually exclusive.
transferProduct	bankingProductReference The banking product for a new account where interest and/or balance are transferred at CD maturity, if maturityPolicy is transferPrincipalAndInterest or rolloverPrincipalAndTransferInterest. transferAccount and transferProduct are mutually exclusive. Unevaluated Properties: false
lastRolloverOn	date(date) The date when the CD last had a rollover or renewal when reaching maturity in YYYY-MM-DD RFC 3339 date format. This may be omitted if this CD has never previously reached maturity. format: date minLength: 10 maxLength: 10
maturesAt	readOnlyTimestamp(date-time) (required) The date-time that this account will mature, in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ. Warning: The property maturesAt was deprecated on version v2.0.0 of the schema. Use the maturesOn field instead. maturesAt will be removed on version v4.0.0 of the schema. read-only format: date-time deprecated: true minLength: 20 maxLength: 30
maturesOn	date(date) (required) The date that this account will mature, in RFC 3339 date format, YYYY-MM-DD. format: date minLength: 10 maxLength: 10
term	string(duration) (required) The CD's maturity term. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. For example, the values P30D, P6M, P2Y indicate a term of 30 days, six months, and two years, respectively. read-only format: duration minLength: 3 maxLength: 6
inDebitGracePeriod	boolean (required) If true, the account is in the grace period in which withdrawals are allowed without penalty.
inCreditGracePeriod	boolean (required) If true, the account is in the grace period in which deposits are allowed without penalty.
debitGracePeriodStartsOn	date(date) If the account is in a debit-eligible grace period, this is the date the grace period started for debits in RFC 3339 date format, YYYY-MM-DD. Otherwise, this field is omitted. format: date minLength: 10 maxLength: 10
creditGracePeriodStartsOn	date(date) If the account is in a credit-eligible grace period, this is the date the grace period started for credits in RFC 3339 date format, YYYY-MM-DD. Otherwise, this field is omitted. format: date minLength: 10 maxLength: 10
debitGracePeriodEndsOn	date(date) If the account is in a debit-eligible grace period, this is the date and time the grace period ends for debits in RFC 3339 date format, YYYY-MM-DD. Otherwise, this field is omitted. format: date minLength: 10 maxLength: 10
creditGracePeriodEndsOn	date(date) If the account is in a credit-eligible grace period, this is the date and time the grace period ends for credits in RFC 3339 date format, YYYY-MM-DD. Otherwise, this field is omitted. format: date minLength: 10 maxLength: 10
debitGracePeriodEndsAt	readOnlyTimestamp(date-time) If the account is in a debit-eligible grace period, this is the date and time the grace period ends for debits in RFC 3339 date-time format, YYYY-MM-DDThh:mm:ssZ. Otherwise, this field is omitted. Warning: The property debitGracePeriodEndsAt was deprecated on version v2.0.0 of the schema. Use the debitGracePeriodEndsOn field instead. debitGracePeriodEndsAt will be removed on version v4.0.0 of the schema. read-only format: date-time deprecated: true minLength: 20 maxLength: 30
creditGracePeriodEndsAt	readOnlyTimestamp(date-time) If the account is in a credit-eligible grace period, this is the date and time the grace period ends for credits in RFC 3339 date-time format, YYYY-MM-DDThh:mm:ssZ. Otherwise, this field is omitted. Warning: The property creditGracePeriodEndsAt was deprecated on version v2.0.0 of the schema. Use the creditGracePeriodEndsOn field instead. creditGracePeriodEndsAt will be removed on version v4.0.0 of the schema. read-only format: date-time deprecated: true minLength: 20 maxLength: 30

cdAccountSettingsPatch

{
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "id": "e821ce54-c715",
    "label": "Premiere Checking *6789",
    "type": "checking",
    "location": "internal"
  }
}

CD Account Settings Patch (v1.2.0)

Mutable CD settings for an account.

Properties

Name	Description
CD Account Settings Patch (v1.2.0)	object Mutable CD settings for an account. Unevaluated Properties: false
maturityPolicy	cdAccountMaturityPolicy What happens to the funds in the account upon maturity. enum values: rolloverPrincipalAndInterest, transferPrincipalAndInterest, rolloverPrincipalAndTransferInterest, holdPrincipalAndInterest, partialTransfer
rolloverProduct	bankingProductReference The CD banking product to roll this account to, if the maturityPolicy indicates a rollover. The default is the same CD banking product. Eligible products are listed in the listEligibleCdRolloverProducts operation. Unevaluated Properties: false
transferAccount	cdMaturityTransferAccount The existing internal or external account where interest and/or balance are transferred at CD maturity if maturityPolicy is transferPrincipalAndInterest or rolloverPrincipalAndTransferInterest. The account must have transferTo entitlements for the account holder. transferAccount and transferProduct are mutually exclusive.
transferProduct	bankingProductReference The banking product for a new account where interest and/or balance are transferred at CD maturity, if maturityPolicy is transferPrincipalAndInterest or rolloverPrincipalAndTransferInterest. transferAccount and transferProduct are mutually exclusive. Unevaluated Properties: false

cdMaturityTransferAccount

{
  "id": "e821ce54-c715",
  "label": "Premiere Checking *6789",
  "type": "checking",
  "location": "internal"
}

CD Transfer Account (v1.0.0)

Properties of the target account for transferring funds from a maturing CD account.

Properties

Name	Description
CD Transfer Account (v1.0.0)	object Properties of the target account for transferring funds from a maturing CD account.
id	resourceId (required) The unique ID of a banking account. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	accountLabel1(text) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. format: text minLength: 1 maxLength: 80
type	productType The product type of the account. enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings, other
location	accountLocation Indicates where an account is held. enum values: internal, external, outside, peer

challengeFactor

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

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

Name	Description
Challenge Factor (v1.2.1)	object A challenge factor. See requiredIdentityChallenge for multiple examples.
id	challengeFactorId The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor. Note: The id will become required in a future update to this schema. minLength: 3 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{3,48}$"
type	challengeFactorType (required) The name of challenge factor. challengeFactorType strings may have one of the following enumerated values: Value Description sms SMS: One-time passcode sent to the primary mobile phone number email Email: One-time passcode sent to the primary email address voice Voice: One-time passcode communicated via automated voice phone call authenticatorToken authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app securityQuestions Security Questions: Prompt with the user's security questions registered with their security profile enum values: sms, email, voice, securityQuestions, authenticatorToken
labels	array: [string] A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address. minItems: 1 maxItems: 4 items: string(text) » format: text » maxLength: 300
securityQuestions	challengeSecurityQuestions Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

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:

Value	Description
sms	SMS: One-time passcode sent to the primary mobile phone number
email	Email: One-time passcode sent to the primary email address
voice	Voice: One-time passcode communicated via automated voice phone call
authenticatorToken	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestions	Security Questions: Prompt with the user's security questions registered with their security profile

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

Name	Description
Challenge Security Question (v1.0.1)	object A single security question within the questions array of the challengeSecurityQuestions
id	challengePromptId (required) The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId. minLength: 1 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]+$"
prompt	string(text) (required) The text prompt of this security question. format: text maxLength: 80

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

Name	Description
Challenge Security Questions (v1.0.1)	object Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.
questions	array: [challengeSecurityQuestion] (required) The array of security questions. minItems: 1 maxItems: 8 items: object

challengeToken

"string"

Challenge Token (v1.1.0)

The value of the identity Challenge request header that the client must send when retrying an operation which required a challenge.

type: string

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

checkClearsAccountAlertSubscription

{
  "enabled": true,
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "checkNumbers": [
    "string"
  ]
}

Check Clears Account Alert Subscription (v1.0.2)

Send an alert to the account holder when one of the specified checks clears.

Properties

Name	Description
Check Clears Account Alert Subscription (v1.0.2)	object Send an alert to the account holder when one of the specified checks clears. Unevaluated Properties: false
enabled	boolean (required) If true, the alert is enabled.
communicationChannels	array: [accountAlertCustomerCommunicationChannel] (required) Channels to communicate this alert subscription. unique items minItems: 0 maxItems: 5 items: object » Unevaluated Properties: false
checkNumbers	array: [checkNumber] (required) The check numbers for which the user has requested alerts. unique items minItems: 0 maxItems: 100 items: string » minLength: 1 » maxLength: 16 » pattern: "^[0-9]{1,16}$"

checkNumber

"string"

Check Number (v1.0.0)

The check number. This is represented as a string because leading 0 digits are significant.

type: string

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

collateralAccountSettings

{
  "hasRepurchaseAgreement": false,
  "insured": false,
  "targetCollateralizationRate": "120.00",
  "collateralizationRate": "120.00",
  "totalCollateral": "80000.00",
  "pledges": [
    {
      "asset": {
        "cusipNumber": "303075105"
      },
      "pledgeTerms": {
        "amount": "6293.41"
      }
    },
    {
      "asset": {
        "cusipNumber": "930482783"
      },
      "pledgeTerms": {
        "amount": "35000.00"
      }
    }
  ]
}

Collateral Account Settings (v1.0.0)

Collateral settings for secured accounts. Secured accounts are typically deposit type accounts (e.g., checking accounts) or loan/credit type accounts.

Properties

Name	Description
Collateral Account Settings (v1.0.0)	object Collateral settings for secured accounts. Secured accounts are typically deposit type accounts (e.g., checking accounts) or loan/credit type accounts. Unevaluated Properties: false
hasRepurchaseAgreement	boolean (required) Indicates that a repurchase agreement (sometimes referred to as 'repo') structure is used in connection with this account. A repurchase agreement is a form of secured financing in which one party sells securities to another party and agrees to repurchase them at a later date, typically at a slightly higher price. Economically, this functions as a short-term, collateralized loan. Both the account and individual pledges may be associated with repurchase agreements, and these indicators operate independently. An account may be marked as having a repurchase agreement even if none of its current pledged assets are associated with one, and conversely, individual pledges may be subject to repurchase agreements even if the account-level flag is false.
insured	boolean (required) Indicates whether the account balance is covered by deposit insurance (e.g., FDIC for banks or NCUA for credit unions). This typically only applies to deposit account types.
targetCollateralizationRate	positiveTwoDecimalRate(decimal) (required) The desired minimum ratio of collateral coverage to the secured account balance, expressed as a percentage. For example, a value of 120.00 means collateral coverage should equal at least 120.00% of the balance. format: decimal minLength: 4 maxLength: 6 pattern: "^(0|[1-9]\\d{0,2})\\.\\d{2}$"
collateralizationRate	positiveTwoDecimalRate(decimal) (required) The ratio of total collateral coverage to the secured account balance, expressed as a percentage. For example, a value of 120.00 means collateral coverage equals 120.00% of the balance. format: decimal minLength: 4 maxLength: 6 pattern: "^(0|[1-9]\\d{0,2})\\.\\d{2}$"
totalCollateral	monetaryValue(decimal) (required) The total value used for collateral coverage calculations. This value is primarily based on the sum of all pledged assets for the account. If insured is true, an additional coverage amount is incorporated into this value, augmenting the pledged asset total to enhance collateral coverage for the deposit liability. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
pledges	array: [accountCollateralPledgeItem] (required) The individual assets pledged as collateral for the account. Each pledge represents a specific instrument or position (such as cash or a security) contributing to the total collateral value. This array is empty if no assets are currently pledged. unique items minItems: 0 maxItems: 250 items: object » Unevaluated Properties: false

countryCode

"US"

Country Code (v1.0.0)

The ISO-3611 alpha-2 value for a country.

type: string

minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"

creditCardAccountSettings

{
  "creditLimit": "18000.00"
}

Credit Card Account Settings (v1.0.0)

Credit card settings for accounts.

Properties

Name	Description
Credit Card Account Settings (v1.0.0)	object Credit card settings for accounts. Unevaluated Properties: false
creditLimit	monetaryValue(decimal) The maximum credit line available for this credit card account. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"

creditOrDebitValue

"3456.78"

Credit Or Debit Value (v1.1.1)

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(decimal)

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

creditUnionAccountSuffix

"S0001"

Credit Union Account Suffix (v1.0.0)

An account suffix which uniquely identifies a credit union member's account. The combined member number and account suffix is unique among all accounts at the credit union.

type: string

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

creditUnionPeerAccount

{
  "fullMemberNumber": "4002",
  "suffix": "C001",
  "maskedMemberNumber": "*02"
}

Credit Union Peer Account (v1.0.0)

A peer account within a credit union financial institution.

Note: The full member number and suffix are omitted unless the request includes the ?unmasked=true query parameter.

Properties

Name	Description
Credit Union Peer Account (v1.0.0)	object A peer account within a credit union financial institution. Note: The full member number and suffix are omitted unless the request includes the ?unmasked=true query parameter.
fullMemberNumber	fullMemberNumber A full (unmasked) credit union member number. minLength: 1 maxLength: 17 pattern: "^[- a-zA-Z0-9.]{1,17}$"
suffix	creditUnionAccountSuffix An account suffix which uniquely identifies a credit union member's account. The combined member number and account suffix is unique among all accounts at the credit union. minLength: 1 maxLength: 6 pattern: "^[a-zA-Z0-9]{1,6}$"
maskedMemberNumber	maskedMemberNumber (required) A masked member number: an asterisk * followed by one to four characters of the fullMemberNumber. minLength: 2 maxLength: 5 pattern: "^\\*[- a-zA-Z0-9.]{1,4}$"

creditUnionPeerAccountReplacement

{
  "fullMemberNumber": "4002",
  "suffix": "C001"
}

New Credit Union Peer Account Patch (v1.0.0)

Identifies a new peer account at a credit union.

Properties

Name	Description
New Credit Union Peer Account Patch (v1.0.0)	object Identifies a new peer account at a credit union.
fullMemberNumber	fullMemberNumber A full (unmasked) credit union member number. minLength: 1 maxLength: 17 pattern: "^[- a-zA-Z0-9.]{1,17}$"
suffix	creditUnionAccountSuffix An account suffix which uniquely identifies a credit union member's account. The combined member number and account suffix is unique among all accounts at the credit union. minLength: 1 maxLength: 6 pattern: "^[a-zA-Z0-9]{1,6}$"

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

cusipNumber

"303075105"

CUSIP Number (v1.0.0)

The unique Committee on Uniform Security Identification Procedures identifier assigned to all securities.

type: string

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

date

"2021-10-30"

Date (v1.0.0)

A date formatted in YYYY-MM-DD RFC 3339 date UTC format.

type: string(date)

format: date
minLength: 10
maxLength: 10

eligibleOverdraftAccountItem

{
  "id": "5c9b4e50a0401ef4eb2e",
  "label": "Premiere Savings *1234",
  "maskedNumber": "*1234"
}

Eligible Overdraft Account (v1.1.0)

An account that is eligible to be assigned as an overdraft protection account for another account.

Properties

Name	Description
Eligible Overdraft Account (v1.1.0)	object An account that is eligible to be assigned as an overdraft protection account for another account.
id	resourceId (required) The unique ID of the account resource. Use this as the {accountId} in getAccount or listAccountBalances. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	string(text) (required) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. read-only format: text maxLength: 80
maskedNumber	maskedAccountNumber (required) A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber. minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"

eligibleOverdraftAccounts

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://api.apiture.com/banking/accounts/f204d292df9fb/eligibleOverdraftAccounts?start=641f62296ecbf1882c84?limit=100",
  "items": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ],
  "maximumOverdraftAccounts": 1
}

Eligible Overdraft Accounts (v1.1.1)

A page of zero or more accounts that are eligible to be assigned as an overdraft protection sweep account for another account.

Properties

Name	Description
Eligible Overdraft Accounts (v1.1.1)	object A page of zero or more accounts that are eligible to be assigned as an overdraft protection sweep account for another account.
limit	integer(int32) (required) The number of items requested for this page response. The length of the items array may be less that limit. format: int32 minimum: 0 maximum: 10000
nextPage_url	string(uri-reference) The URL of the next page of eligible accounts. If this URL is omitted, there are no more accounts. read-only format: uri-reference maxLength: 256
start	string(text) The opaque cursor that specifies the starting location of this page of items. format: text maxLength: 256
items	array: [eligibleOverdraftAccountItem] (required) The items in this page of accounts. unique items maxItems: 1000 items: object
maximumOverdraftAccounts	integer(int32) (required) The maximum number of overdraft protection accounts that may be linked to the account. read-only format: int32 minimum: 0 maximum: 4

extendedPhoneNumber

"+19105550155"

Extended Phone Number (v1.0.0)

A phone number with optional extension. Phone numbers are free-form strings and may include letters (such as '1-800-APITURE'), extensions (such as '919-555-1234 ext 34') or country code prefixes such as '+19105550155'.

type: string(extended-phone-number)

format: extended-phone-number
minLength: 5
maxLength: 20

externalAccountVerificationMethod

"instant"

External Account Verification Method (v1.1.0)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

Value	Description
instant	Instant Account Verification: Access to the external account is verified via integration with an account verification service provider.
microDeposits	Micro-Deposits: Access to the external account is verified via verifying a set of micro-deposits.
manual	Manual: Access to the external account is verified manually by the financial institution.

type: string

enum values: instant, microDeposits, manual

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

fullAccountNumberResponse

{
  "fullAccountNumber": "123456789"
}

Full Account Number Response (v1.0.1)

The response to a request to get an account's full unmasked account number.

Properties

Name	Description
Full Account Number Response (v1.0.1)	object The response to a request to get an account's full unmasked account number. Unevaluated Properties: false
fullAccountNumber	fullAccountNumber (required) The full unmasked account number or member number. 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,
  "viewLoanPayoffQuote": false,
  "realTimePaymentFrom": true,
  "realTimePaymentTo": true,
  "manageCdSettings": false,
  "manageCdProductSettings": false,
  "manageOverdraftAccounts": true,
  "manageJointOwners": true,
  "generateVerificationLetter": true,
  "viewInterestDisbursement": false,
  "manageInterestDisbursement": false,
  "viewElectronicDocuments": true,
  "viewElectronicStatements": true,
  "viewBeneficiaries": true,
  "manageBeneficiaries": true,
  "manageAccountAccess": true,
  "manageTransfers": true,
  "manageAlerts": true,
  "stopPayments": true,
  "viewImages": true,
  "manageDisputes": true,
  "editTransactions": true,
  "manuallyRefreshBalance": true,
  "orderDebitCard": false,
  "viewCollateral": false,
  "makePayment": false
}

Full Account Permissions (v13.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

Name	Description
Full Account Permissions (v13.0.0)	object 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.
billPay	boolean (required) If true, the customer may use this account for Bill Pay.
mobileCheckDeposit	boolean (required) If true, the customer may use this account for mobile check deposits.
transferFrom	boolean (required) If true, the customer may use this account as the source (debit) account for account-to-account transfers.
transferTo	boolean (required) If true, the customer may use this account as the target (deposit) account for account-to-account transfers.
view	boolean (required) If true, the customer may view the details of this account, including the account balance and transactions.
viewCards	boolean (required) If true, the customer may view debit cards associated with this account.
manageCards	boolean (required) If true, the customer may manage debit cards associated with this account. This includes locking and unlocking cards, changing card controls, ordering cards, or canceling cards.
viewLoanPayoffQuote	boolean (required) If true, the customer may view a loan payoff quote for this account. Only valid for accounts where product.type is loan.
realTimePaymentFrom	boolean (required) If true, the customer may use this account to send credit real-time payments.
realTimePaymentTo	boolean (required) If true, the customer may use this account to receive debit real-time payments.
manageCdSettings	boolean (required) If true, the customer may manage CD settings for this account.
manageCdProductSettings	boolean (required) If true, the CD account is in the maturity grace period and is eligible for changing rollover settings.
manageJointOwners	boolean (required) If true, the customer can list the other joint owners on the account and invite new joint owners.
manageOverdraftAccounts	boolean (required) If true, the customer can list and manage additional overdraft sweep accounts to use for overdraft protection.
generateVerificationLetter	boolean (required) If true, the customer can obtain a verification letter for this account.
viewInterestDisbursement	boolean (required) If true, the customer can view the interest disbursement settings.
manageInterestDisbursement	boolean (required) If true, the customer can manage the interest disbursement settings.
viewElectronicDocuments	boolean (required) If true, the customer can view any documents associated with the account.
viewElectronicStatements	boolean (required) If true, the customer can view monthly statements for the account.
viewBeneficiaries	boolean (required) If true, the customer can view beneficiaries on the account.
manageBeneficiaries	boolean (required) If true, the customer can manage beneficiaries on the account.
manageAccountAccess	boolean (required) If true, the customer can manage account access on the account.
manageTransfers	boolean (required) If true, the customer can manage transfers on the account.
manageAlerts	boolean (required) If true, the customer can manage alerts on the account.
stopPayments	boolean (required) If true, the customer can stop check or ACH payments on the account.
viewImages	boolean (required) If true, the customer can view account transactions images such as processed checks and deposit slips on the account.
manageDisputes	boolean (required) If true, the customer can manage disputes on the account.
editTransactions	boolean (required) If true, the customer can edit transactions for the account.
manuallyRefreshBalance	boolean (required) If true, the customer may refresh the balance of the account.
orderDebitCard	boolean (required) If true, the customer may order a debit card for this account.
viewCollateral	boolean (required) If true, the customer may view the collateral details for the account.
makePayment	boolean (required) If true, the customer may make a loan or credit card payment on the account.

fullMemberNumber

"123456789"

Full Member Number (v1.0.0)

A full (unmasked) credit union member number.

type: string

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

identityChallengeText

{
  "factorSelection": "Select one of the following methods to verify your identity for security purposes.",
  "maximumFailures": "You have failed identity verification too many times. Contact your financial institution."
}

Identity Challenge Text (v1.0.0)

Optional text to display during an identity challenge user experience. All text fields are optional. If present, the text overrides default text defined by the system or financial institution.

The text values may be HTML or plain text.

Properties

Name	Description
Identity Challenge Text (v1.0.0)	object Optional text to display during an identity challenge user experience. All text fields are optional. If present, the text overrides default text defined by the system or financial institution. The text values may be HTML or plain text. Unevaluated Properties: false
factorSelection	string(text) Text shown to the user when the application asks them to choose which verification factor to use to verify their identity. format: text minLength: 8 maxLength: 512
maximumFailures	string(text) Text shown to the user when the user has failed identity verification the maximum number of attempts, as configured by the financial institution. format: text minLength: 8 maxLength: 512
email	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode sent to their chosen email address. format: text minLength: 8 maxLength: 512
sms	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode sent to their chosen mobile (SMS) phone number. format: text minLength: 8 maxLength: 512
authenticatorToken	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode from their hardware or software authenticator device. format: text minLength: 8 maxLength: 512
voice	string(text) Text shown to the user when the client prompts the user to enter a one-time passcode sent to their chosen voice phone number. format: text minLength: 8 maxLength: 512
securityQuestions	string(text) Text shown to the user when the client prompts the user to enter a an answer to one of their security questions. format: text minLength: 8 maxLength: 512

incompleteAccountBalance

{
  "id": "05d00d7d-d630",
  "available": "3208.20",
  "current": "3448.72",
  "computedBalanceDifference": "-240.52",
  "currentWithPending": "3448.72",
  "updatedAt": "2022-05-02T06:51:19.375Z",
  "incomplete": false,
  "primary": {
    "balance": "3208.20",
    "label": "Available",
    "description": "The amount of money available for use, typically the previous day's closing balance plus or minus any pending transactions"
  },
  "initialFunding": false,
  "interest": {
    "yearToDate": "284.32",
    "priorYear": "837.20",
    "accrued": "60.12"
  }
}

Incomplete Account Balance (v1.7.0)

The incomplete balances of the given account.

If the primary balance is the current balance, then the secondary balance is the available balance, and if the primary balance is the available balance, then the secondary balance is the current balance. The fields primary.balanceand secondary.balance are optional since they may not be available.

Properties

Name	Description
Incomplete Account Balance (v1.7.0)	object The incomplete balances of the given account. If the primary balance is the current balance, then the secondary balance is the available balance, and if the primary balance is the available balance, then the secondary balance is the current balance. The fields primary.balanceand secondary.balance are optional since they may not be available.
id	resourceId (required) The account ID. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
available	creditOrDebitValue(decimal) The available balance: the funds available for use. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
current	creditOrDebitValue(decimal) The current balance: the balance at the end of the previous business day. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
computedBalanceDifference	creditOrDebitValue(decimal) Computed difference between available and current balances (available - current) representing the net impact of pending or held activity on funds availability. This is the string representation of the exact decimal amount. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
collected	creditOrDebitValue(decimal) The available balance excluding deposited checks that have not yet cleared. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
sweep	creditOrDebitValue(decimal) The aggregate balance available for automatic transfer (sweeping) between accounts based on configured balance rules. Sweep operations move funds automatically when account balances cross specified thresholds, supporting various cash management strategies including overdraft protection, balance optimization, and liquidity management. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
updatedAt	readOnlyTimestamp(date-time) The time when the balance values were last updated from the banking core. read-only format: date-time minLength: 20 maxLength: 30
currentWithPending	creditOrDebitValue(decimal) The current balance, including pending transactions. This is the string representation of the exact decimal amount. read-only format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
incomplete	boolean (required) If true, the response is incomplete and the client may retry the operation after the Retry-After time in order to fetch balances for any incomplete accounts in the items. The retry operation should only pass in accounts that are incomplete.
paymentDue	paymentDue The payment due details on the account. This is excluded when the account type does not support payments, or when a payment is not due. Unevaluated Properties: false
paymentPastDue	paymentPastDue The payment past due details on the account. This is excluded when the account type does not support payments, or when the payment is not past due. Unevaluated Properties: false
automaticPayment	automaticPayment The automatic payment details for a credit/loan account. This is excluded when the account type does not support automatic payments, or when there is no automatic payment scheduled. Unevaluated Properties: false
initialFunding	boolean If true, the user can create an initial funding transfer to deposit funds into the account. default: false
interest	accountInterest The interest-related totals and disbursement details for the account. Unevaluated Properties: false
primary	incompletePrimaryBalance The primary balance for the account. This could be either available or current balance depending on the product.type of the account. Unevaluated Properties: false
secondary	incompleteSecondaryBalance The secondary balance for the account. This could be either available or current balance depending on the product.type of the account. Unevaluated Properties: false

incompleteAccountBalances

{
  "items": [
    {
      "id": "05d00d7d-d630",
      "available": "3208.20",
      "current": "3448.72",
      "currentWithPending": "3448.72",
      "updatedAt": "2022-05-02T06:51:19.375Z",
      "incomplete": false
    },
    {
      "id": "cb5d67ea-a5c3",
      "available": "1750.80",
      "current": "1956.19",
      "currentWithPending": "1956.19",
      "updatedAt": "2022-05-02T06:51:19.375Z",
      "incomplete": false
    },
    {
      "id": "b5a4f178-2baf",
      "incomplete": true
    },
    {
      "id": "959908db-fd40",
      "incomplete": true
    },
    {
      "id": "97e6166a-2a4c",
      "incomplete": true
    }
  ],
  "incompleteAccounts": [
    "b5a4f178-2baf",
    "959908db-fd40",
    "97e6166a-2a4c"
  ],
  "retryCount": 1
}

Incomplete Account Balance (v2.3.0)

An array of account balances by account ID, some of which are incomplete. Use the values in incompleteAccounts and retryCount to retry the listAccountBalances operation.

Properties

Name	Description
Incomplete Account Balance (v2.3.0)	object An array of account balances by account ID, some of which are incomplete. Use the values in incompleteAccounts and retryCount to retry the listAccountBalances operation.
items	array: [incompleteAccountBalance] (required) An array of items, one for each of the ?accounts= in the request, returned in the same order. maxItems: 256 items: object
incompleteAccounts	array: [resourceId] (required) Pass these values as the ?accounts= query parameter on the next retry of the listAccountBalances operation. This value is empty if the client has reached the retry limit. unique items minItems: 1 maxItems: 1000 items: string » minLength: 6 » maxLength: 48 » pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
retryCount	integer(int32) (required) Pass this value as the as the ?retryCount= parameter with the next retry of the listAccountBalances operation. format: int32 minimum: 1 maximum: 10

incompletePrimaryBalance

{
  "balance": "3208.20",
  "label": "Available",
  "description": "The amount of money available for use, typically the previous day's closing balance plus or minus any pending transactions"
}

Incomplete Primary Balance (v1.0.1)

The incomplete primary balance of an account.

Properties

Name	Description
Incomplete Primary Balance (v1.0.1)	object The incomplete primary balance of an account. Unevaluated Properties: false
label	string(text) (required) The human-readable label for the balance. format: text minLength: 1 maxLength: 50
description	string(text) (required) The human-readable description of the balance. format: text minLength: 1 maxLength: 500
balance	creditOrDebitValue(decimal) The primary balance of the account. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

incompleteSecondaryBalance

{
  "balance": "2253.22",
  "label": "Current",
  "description": "Total account value including principal and earned interest"
}

Incomplete Secondary Balance (v1.0.1)

The incomplete secondary balance of an account.

Properties

Name	Description
Incomplete Secondary Balance (v1.0.1)	object The incomplete secondary balance of an account. Unevaluated Properties: false
label	string(text) (required) The human-readable label for the balance. format: text minLength: 1 maxLength: 50
description	string(text) (required) The human-readable description of the balance. format: text minLength: 1 maxLength: 500
balance	creditOrDebitValue(decimal) The secondary balance of the account. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

individualBeneficiaryRequest

{
  "firstName": "Bobby",
  "lastName": "Tables",
  "taxId": "111111111",
  "birthdate": "1990-01-01",
  "relationship": "Person",
  "primaryPhoneNumber": "+19105550155",
  "primaryEmail": "test@example.com",
  "primaryAddress": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  }
}

Individual Beneficiary Request (v2.0.1)

Details of a beneficiary who is an individual person, used in a request.

Properties

Name	Description
Individual Beneficiary Request (v2.0.1)	object Details of a beneficiary who is an individual person, used in a request. Unevaluated Properties: false
firstName	string(text) (required) The beneficiary's first name. format: text maxLength: 32
middleName	string(text) The beneficiary's middle name. format: text maxLength: 32
lastName	string(text) (required) The beneficiary's last name. format: text maxLength: 32
suffix	string(text) The beneficiary's suffix, such as Sr., III, RN, M.D. or PhD. format: text maxLength: 32
taxId	bankingCustomerTaxId(text) The beneficiary's tax ID. format: text minLength: 9 maxLength: 11
birthdate	string(date) (required) The beneficiary's birth date, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10
relationship	string(text) The beneficiary's relationship to the primary account owner, such as child or spouse. format: text maxLength: 32
primaryPhoneNumber	extendedPhoneNumber(extended-phone-number) The beneficiary's primary phone number. format: extended-phone-number minLength: 5 maxLength: 20
primaryEmail	string(email) The beneficiary's primary email address. format: email maxLength: 255
primaryAddress	usRequestAddress (required) The beneficiary's primary address.

individualBeneficiaryResponse

{
  "firstName": "Bobby",
  "lastName": "Tables",
  "taxId": "111111111",
  "birthdate": "1990-01-01",
  "relationship": "Person",
  "primaryPhoneNumber": "+19105550155",
  "primaryEmail": "test@example.com",
  "primaryAddress": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  }
}

Individual Beneficiary Response (v2.0.1)

Details of a beneficiary who is an individual person, used in a response.

Properties

Name	Description
Individual Beneficiary Response (v2.0.1)	object Details of a beneficiary who is an individual person, used in a response. Unevaluated Properties: false
firstName	string(text) (required) The beneficiary's first name. format: text maxLength: 32
middleName	string(text) The beneficiary's middle name. format: text maxLength: 32
lastName	string(text) (required) The beneficiary's last name. format: text maxLength: 32
suffix	string(text) The beneficiary's suffix, such as Sr., III, RN, M.D. or PhD. format: text maxLength: 32
taxId	bankingCustomerTaxId(text) The beneficiary's tax ID. format: text minLength: 9 maxLength: 11
birthdate	string(date) (required) The beneficiary's birth date, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10
relationship	string(text) The beneficiary's relationship to the primary account owner, such as child or spouse. format: text maxLength: 32
primaryPhoneNumber	extendedPhoneNumber(extended-phone-number) The beneficiary's primary phone number. format: extended-phone-number minLength: 5 maxLength: 20
primaryEmail	string(email) The beneficiary's primary email address. format: email maxLength: 255
primaryAddress	usResponseAddress (required) The beneficiary's primary address.

interestDisbursementTargetAccountReference

{
  "id": "v080fd9fsjrkj2sfd234d",
  "label": "Personal Checking *4455"
}

Interest Disbursement Target Account Reference (v1.0.0)

The banking account designated to receive interest disbursements.

Properties

Name	Description
Interest Disbursement Target Account Reference (v1.0.0)	object The banking account designated to receive interest disbursements. Unevaluated Properties: false
id	resourceId (required) The unique ID of a banking account. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	accountLabel1(text) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. format: text minLength: 1 maxLength: 80

iraAccountSettings

{
  "term": "P6M"
}

IRA Account Settings (v1.0.0)

IRA settings for accounts.

Properties

Name	Description
IRA Account Settings (v1.0.0)	object IRA settings for accounts. Unevaluated Properties: false
term	string(duration) (required) The IRA's maturity term. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. For example, the values P30D, P6M, P2Y indicate a term of 30 days, six months, and two years, respectively. format: duration minLength: 3 maxLength: 6

jointOwnerInvitation

{
  "id": "db4f580290d3e07bf55d",
  "firstName": "Mary",
  "lastName": "Jones",
  "taxId": "3333",
  "sharedSecret": "obsolete obese octopus",
  "emailAddress": "Mary.Jones@example.com",
  "birthdate": "2000-04-10"
}

Joint Owner Invitation (v3.0.1)

A joint owner invitation.

Properties

Name	Description
Joint Owner Invitation (v3.0.1)	object A joint owner invitation.
firstName	string(text) (required) The invitee's first name. format: text minLength: 1 maxLength: 32
lastName	string(text) (required) The invitee's last name name. format: text minLength: 1 maxLength: 32
taxId	string (required) The last 4 digits of the invitee's tax ID number (Social Security Number). This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the last four digits of the tax ID they use to enroll. minLength: 4 maxLength: 4 pattern: "^[0-9]{4}$"
birthdate	string(date) (required) The birthdate of the invitee, in RFC 3339 YYYY-MM-DD date format. This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the birthdate they use to enroll. format: date minLength: 10 maxLength: 10
sharedSecret	string(text) (required) A string shared by the inviter with the invitee to verify their identity. This is not sent in the invitation. The inviter should share this string with the invitee though another channel. format: text minLength: 5 maxLength: 30
emailAddress	string(email) (required) The invitee's email address. format: email maxLength: 80
id	resourceId (required) The unique ID of the invitation. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

jointOwnerInvitationFields

{
  "firstName": "string",
  "lastName": "string",
  "taxId": "stri",
  "birthdate": "2019-08-24",
  "sharedSecret": "string",
  "emailAddress": "user@example.com"
}

Joint Owner Invitation Fields (v3.0.0)

Fields used to compose other joint owner invitation schemas.

Properties

Name	Description
Joint Owner Invitation Fields (v3.0.0)	object Fields used to compose other joint owner invitation schemas.
firstName	string(text) (required) The invitee's first name. format: text minLength: 1 maxLength: 32
lastName	string(text) (required) The invitee's last name name. format: text minLength: 1 maxLength: 32
taxId	string (required) The last 4 digits of the invitee's tax ID number (Social Security Number). This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the last four digits of the tax ID they use to enroll. minLength: 4 maxLength: 4 pattern: "^[0-9]{4}$"
birthdate	string(date) (required) The birthdate of the invitee, in RFC 3339 YYYY-MM-DD date format. This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the birthdate they use to enroll. format: date minLength: 10 maxLength: 10
sharedSecret	string(text) (required) A string shared by the inviter with the invitee to verify their identity. This is not sent in the invitation. The inviter should share this string with the invitee though another channel. format: text minLength: 5 maxLength: 30
emailAddress	string(email) (required) The invitee's email address. format: email maxLength: 80

loanAccountSettings

{
  "originalLoanAmount": "5000.00"
}

Loan Account Settings (v1.0.0)

Loan settings for accounts.

Properties

Name	Description
Loan Account Settings (v1.0.0)	object Loan settings for accounts. Unevaluated Properties: false
creditLimit	monetaryValue(decimal) The maximum credit allowed for loan advances against this loan account. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
originalLoanAmount	monetaryValue(decimal) The original principal amount of this loan account at loan origination. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"

loanPayoffQuote

{
  "amount": {
    "value": "1000.00",
    "currency": "USD"
  },
  "payoffOn": "2024-07-22",
  "payoffEffectiveOn": "2024-07-22",
  "label": "The payoff amount of $1,0000.00 is valid through Monday, July 22 2024."
}

Loan Payoff Quote (v1.0.1)

Response when a loan payoff quote is requested.

The payoffEffectiveOn date may have been adjusted from the payoffOn date to ensure the payoff date falls on a business day.

The amount includes daily accrued interest up to and including the payoffEffectiveOn date.

Properties

Name	Description
Loan Payoff Quote (v1.0.1)	object Response when a loan payoff quote is requested. The payoffEffectiveOn date may have been adjusted from the payoffOn date to ensure the payoff date falls on a business day. The amount includes daily accrued interest up to and including the payoffEffectiveOn date.
amount	money (required) The total amount that must be paid to satisfy the loan, including the current balance and daily accrued interest up to and including the payoffEffectiveOn date.
payoffOn	date(date) (required) The target loan payoff date, in YYYY-MM-DD RFC 3339 date UTC format. format: date minLength: 10 maxLength: 10
payoffEffectiveOn	date(date) (required) The effective loan payoff date, which may have been adjusted from the target loan payoff date, in YYYY-MM-DD RFC 3339 date UTC format. format: date minLength: 10 maxLength: 10
label	string(text) (required) A pre-formatted message meant to display information about the loan payoff, such as effective loan payoff date and amount. format: text maxLength: 2048

loanPayoffQuoteRequest

{
  "payoffOn": "2024-07-22"
}

Loan Payoff Quote Request (v1.0.1)

Request for a loan payoff quote.

Properties

Name	Description
Loan Payoff Quote Request (v1.0.1)	object Request for a loan payoff quote.
payoffOn	date(date) (required) The target loan payoff date, in YYYY-MM-DD RFC 3339 date UTC format. format: date minLength: 10 maxLength: 10

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

maskedMemberNumber

"*1008"

Masked Member Number (v1.0.0)

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

type: string

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

monetaryThresholdAccountAlertSubscription

{
  "enabled": true,
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ],
  "threshold": "3456.78"
}

Monetary Threshold Account Alert Subscription (v1.0.2)

An account alert subscription based on an enabled flag, a monetary threshold and communication channels.

Properties

Name	Description
Monetary Threshold Account Alert Subscription (v1.0.2)	object An account alert subscription based on an enabled flag, a monetary threshold and communication channels. Unevaluated Properties: false
enabled	boolean (required) If true, the alert is enabled.
communicationChannels	array: [accountAlertCustomerCommunicationChannel] (required) Channels to communicate this alert subscription. unique items minItems: 0 maxItems: 5 items: object » Unevaluated Properties: false
threshold	accountAlertMonetaryThreshold(decimal) (required) The monetary value, supporting only positive dollar amounts without decimal (cents) values. Use a threshold of 0 and an empty list of communication channels to disable this alert. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$" Unevaluated Properties: false

monetaryValue

"3456.78"

Monetary Value (v1.1.1)

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(decimal)

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

money

{
  "value": "1000.00",
  "currency": "USD"
}

Money (v1.0.2)

An amount of money in a specific currency.

Properties

Name	Description
Money (v1.0.2)	object An amount of money in a specific currency.
value	monetaryValue(decimal) The net monetary value. A negative amount denotes a debit; a positive amount denotes a credit. The numeric value is represented as a string so that it can be exact with no loss of precision. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
currency	currencyCode(text) The ISO 4217 currency code for this monetary value. format: text minLength: 3 maxLength: 3 pattern: "^[A-Z]{3}$"

newBankPeerAccount

{
  "fullAccountNumber": "123456789"
}

New Bank Peer Account (v1.0.0)

Identifies a new peer account at a bank.

Properties

Name	Description
New Bank Peer Account (v1.0.0)	object Identifies a new peer account at a bank.
fullAccountNumber	fullAccountNumber (required) A full account number. This is the number that the customer uses to reference the account within the financial institution. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"

newCreditUnionPeerAccount

{
  "fullMemberNumber": "4002",
  "suffix": "C001"
}

New Credit Union Peer Account (v1.1.0)

Identifies a new peer account at a credit union.

Properties

Name	Description
New Credit Union Peer Account (v1.1.0)	object Identifies a new peer account at a credit union.
fullMemberNumber	fullMemberNumber (required) A full (unmasked) credit union member number. minLength: 1 maxLength: 17 pattern: "^[- a-zA-Z0-9.]{1,17}$"
suffix	creditUnionAccountSuffix An account suffix which uniquely identifies a credit union member's account. The combined member number and account suffix is unique among all accounts at the credit union. minLength: 1 maxLength: 6 pattern: "^[a-zA-Z0-9]{1,6}$"

newJointOwnerInvitation

{
  "firstName": "Mary",
  "lastName": "Jones",
  "taxId": "3333",
  "sharedSecret": "obsolete obese octopus",
  "emailAddress": "Mary.Jones@example.com",
  "birthdate": "2000-04-10"
}

New Joint Owner Invitation (v3.0.0)

A request to create an invitation to add a new joint owner to an account.

Properties

Name	Description
New Joint Owner Invitation (v3.0.0)	object A request to create an invitation to add a new joint owner to an account.
firstName	string(text) (required) The invitee's first name. format: text minLength: 1 maxLength: 32
lastName	string(text) (required) The invitee's last name name. format: text minLength: 1 maxLength: 32
taxId	string (required) The last 4 digits of the invitee's tax ID number (Social Security Number). This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the last four digits of the tax ID they use to enroll. minLength: 4 maxLength: 4 pattern: "^[0-9]{4}$"
birthdate	string(date) (required) The birthdate of the invitee, in RFC 3339 YYYY-MM-DD date format. This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the birthdate they use to enroll. format: date minLength: 10 maxLength: 10
sharedSecret	string(text) (required) A string shared by the inviter with the invitee to verify their identity. This is not sent in the invitation. The inviter should share this string with the invitee though another channel. format: text minLength: 5 maxLength: 30
emailAddress	string(email) (required) The invitee's email address. format: email maxLength: 80

newPeerAccount

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "creditUnion": {
    "fullMemberNumber": "4002",
    "suffix": "C001"
  }
}

New Peer Account (v2.0.0)

Representation used to create a new peer account. The object must contain either bank or creditUnion properties (but not both).

Properties

Name	Description
New Peer Account (v2.0.0)	object Representation used to create a new peer account. The object must contain either bank or creditUnion properties (but not both).
firstName	string(text) (required) The account holder's first name. format: text maxLength: 24
lastName	string(text) (required) The account holder's last name. format: text maxLength: 24
nickname	accountNickname(text) (required) A nickname for this account. format: text maxLength: 50
type	peerAccountProductType (required) The type (or category) of banking product. peerAccountProductType strings may have one of the following enumerated values: Value Description savings Savings: Savings Account checking Checking: Checking Account loan Loan: Loan Account enum values: savings, checking, loan
bank	newBankPeerAccount Identifies a new peer account at a bank.
creditUnion	newCreditUnionPeerAccount Identifies a new peer account at a credit union.

nullableIndividualBeneficiaryRequest

{
  "firstName": "Bobby",
  "lastName": "Tables",
  "taxId": "111111111",
  "birthdate": "1990-01-01",
  "relationship": "Person",
  "primaryPhoneNumber": "+19105550155",
  "primaryEmail": "test@example.com",
  "primaryAddress": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  }
}

Nullable Individual Beneficiary Request (v1.0.1)

Details of a beneficiary who is an individual person, used in a request. This allows passing null to the patchBeneficiaries operation to remove an individual beneficiary from the array of beneficiaries.

Properties

Name	Description
Nullable Individual Beneficiary Request (v1.0.1)	object | null Details of a beneficiary who is an individual person, used in a request. This allows passing null to the patchBeneficiaries operation to remove an individual beneficiary from the array of beneficiaries. nullable Unevaluated Properties: false
firstName	string(text) (required) The beneficiary's first name. format: text maxLength: 32
middleName	string(text) The beneficiary's middle name. format: text maxLength: 32
lastName	string(text) (required) The beneficiary's last name. format: text maxLength: 32
suffix	string(text) The beneficiary's suffix, such as Sr., III, RN, M.D. or PhD. format: text maxLength: 32
taxId	bankingCustomerTaxId(text) The beneficiary's tax ID. format: text minLength: 9 maxLength: 11
birthdate	string(date) (required) The beneficiary's birth date, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10
relationship	string(text) The beneficiary's relationship to the primary account owner, such as child or spouse. format: text maxLength: 32
primaryPhoneNumber	extendedPhoneNumber(extended-phone-number) The beneficiary's primary phone number. format: extended-phone-number minLength: 5 maxLength: 20
primaryEmail	string(email) The beneficiary's primary email address. format: email maxLength: 255
primaryAddress	usRequestAddress (required) The beneficiary's primary address.

nullableOrganizationBeneficiaryRequest

{
  "type": "nonProfit",
  "legalName": "Doctors Without Borders USA",
  "taxId": "111111111",
  "primaryPhoneNumber": "+19105550155",
  "primaryEmail": "test@example.com",
  "primaryAddress": {
    "address1": "40 Rector St.",
    "address2": "16th Floor",
    "locality": "New York",
    "regionCode": "NY",
    "countryCode": "US",
    "postalCode": "10006"
  }
}

Nullable Organization Beneficiary Request (v1.0.0)

Details of a trust or charity/non-profit beneficiary. This allows passing null to the patchBeneficiaries operation to remove an organization beneficiary from the array of beneficiaries. Trusts must include the date the trust was established.

Properties

Name	Description
Nullable Organization Beneficiary Request (v1.0.0)	object | null Details of a trust or charity/non-profit beneficiary. This allows passing null to the patchBeneficiaries operation to remove an organization beneficiary from the array of beneficiaries. Trusts must include the date the trust was established. nullable Unevaluated Properties: false
type	beneficiaryOrganizationType The type of the beneficiary organization. beneficiaryOrganizationType strings may have one of the following enumerated values: Value Description trust Trust: The beneficiary organization is a trust. nonProfit Non-Profit: The beneficiary organization is a charity or non-profit. enum values: trust, nonProfit
legalName	string(text) (required) The organization's legal name. format: text maxLength: 32
establishedOn	string(date) The date the trust was established, in RFC 3339 YYYY-MM-DD date format. This is required when type is trust, and not applicable for any other type. format: date minLength: 10 maxLength: 10
taxId	bankingOrganizationTaxId(text) (required) The organization's tax ID. format: text minLength: 5 maxLength: 11
primaryPhoneNumber	extendedPhoneNumber(extended-phone-number) The organization's primary phone number. format: extended-phone-number minLength: 5 maxLength: 20
primaryEmail	string(email) The organization's primary email address. This is only applicable when type is nonProfit. format: email maxLength: 255
primaryAddress	usRequestAddress (required) The organization's primary address.

organizationBeneficiary

{
  "type": "nonProfit",
  "legalName": "Doctors Without Borders USA",
  "taxId": "111111111",
  "primaryPhoneNumber": "+19105550155",
  "primaryEmail": "test@example.com",
  "primaryAddress": {
    "address1": "40 Rector St.",
    "address2": "16th Floor",
    "locality": "New York",
    "regionCode": "NY",
    "countryCode": "US",
    "postalCode": "10006"
  }
}

Organization Beneficiary (v2.0.0)

Details of a trust or charity/non-profit beneficiary. Trusts must include the date the trust was established.

Properties

Name	Description
Organization Beneficiary (v2.0.0)	object Details of a trust or charity/non-profit beneficiary. Trusts must include the date the trust was established. Unevaluated Properties: false
type	beneficiaryOrganizationType The type of the beneficiary organization. beneficiaryOrganizationType strings may have one of the following enumerated values: Value Description trust Trust: The beneficiary organization is a trust. nonProfit Non-Profit: The beneficiary organization is a charity or non-profit. enum values: trust, nonProfit
legalName	string(text) (required) The organization's legal name. format: text maxLength: 32
establishedOn	string(date) The date the trust was established, in RFC 3339 YYYY-MM-DD date format. This is required when type is trust, and not applicable for any other type. format: date minLength: 10 maxLength: 10
taxId	bankingOrganizationTaxId(text) (required) The organization's tax ID. format: text minLength: 5 maxLength: 11
primaryPhoneNumber	extendedPhoneNumber(extended-phone-number) The organization's primary phone number. format: extended-phone-number minLength: 5 maxLength: 20
primaryEmail	string(email) The organization's primary email address. This is only applicable when type is nonProfit. format: email maxLength: 255
primaryAddress	usResponseAddress (required) The organization's primary address.

overdraftAccountItem

{
  "id": "5c9b4e50a0401ef4eb2e",
  "label": "Premiere Savings *1234",
  "maskedNumber": "*1234"
}

Overdraft Account Items (v1.1.0)

An overdraft protection account linked to another protected account. The label and maskedNumber are informational only.

Properties

Name	Description
Overdraft Account Items (v1.1.0)	object An overdraft protection account linked to another protected account. The label and maskedNumber are informational only.
id	resourceId (required) The unique ID of the account resource. Use this as the {accountId} in getAccount or listAccountBalances. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	string(text) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. read-only format: text maxLength: 80
maskedNumber	maskedAccountNumber A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber. minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"

overdraftAccountSettings

{
  "protectionElections": {
    "primary": {
      "election": true,
      "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
    },
    "secondary": {
      "election": false
    }
  },
  "limit": "100.00"
}

Overdraft Account Settings (v1.0.0)

Overdraft settings for accounts.

Properties

Name	Description
Overdraft Account Settings (v1.0.0)	object Overdraft settings for accounts. Unevaluated Properties: false
protectionElections	overdraftProtectionElections Describes whether the account holder elected primary or secondary overdraft protection for the account and when those elections were last updated.
limit	monetaryValue(decimal) The maximum amount the account is allowed to be overdrawn. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"

overdraftProtection

{
  "maximumOverdraftAccounts": 1,
  "accounts": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ],
  "elections": {
    "primary": {
      "election": true,
      "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
    },
    "secondary": {
      "election": false
    }
  }
}

Overdraft Protection Settings (v1.2.0)

Representation of the overdraft protection settings, consisting of a list of overdraft protection accounts linked to the account identified by the {accountId} (also known as overdraft protection sweep accounts), and elections for the primary and secondary overdraft protection plans.

Properties

Name	Description
Overdraft Protection Settings (v1.2.0)	object Representation of the overdraft protection settings, consisting of a list of overdraft protection accounts linked to the account identified by the {accountId} (also known as overdraft protection sweep accounts), and elections for the primary and secondary overdraft protection plans.
accounts	array: [overdraftAccountItem] (required) The ordered list of accounts assigned as overdraft protection sweep accounts. This array is limited to no more than maximumOverdraftAccounts accounts. unique items maxItems: 4 items: object
maximumOverdraftAccounts	integer(int32) (required) The maximum number of overdraft protection accounts that may be linked to the account. read-only format: int32 minimum: 0 maximum: 4
elections	overdraftProtectionElections (required) Describes whether the account holder elected primary or secondary overdraft protection for the account and when those elections were last updated.

overdraftProtectionElection

{
  "election": true,
  "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
}

Overdraft Protection Election (v1.0.0)

Overdraft Protection Election. Describes whether an account holder has elected for an overdraft protection plan for this account or not, and when that election was last updated.

Properties

Name	Description
Overdraft Protection Election (v1.0.0)	object Overdraft Protection Election. Describes whether an account holder has elected for an overdraft protection plan for this account or not, and when that election was last updated.
election	boolean (required) If true, an account holder has elected to enable an overdraft protection plan for this account. false if the account holder has never set an election option or if the last change was to opt out of the plan.
lastUpdatedAt	readOnlyTimestamp(date-time) The date and time when an account holder last changed the overdraft protection plan election. This property is omitted if an account holder has not yet changed the election for this plan. read-only format: date-time minLength: 20 maxLength: 30

overdraftProtectionElections

{
  "primary": {
    "election": true,
    "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
  },
  "secondary": {
    "election": false
  }
}

Overdraft Protection Elections (v1.0.0)

Describes whether the account holder elected primary or secondary overdraft protection for the account and when those elections were last updated.

Properties

Name	Description
Overdraft Protection Elections (v1.0.0)	object Describes whether the account holder elected primary or secondary overdraft protection for the account and when those elections were last updated.
primary	overdraftProtectionElection (required) Describes whether an account holder elected for the account to participate in the financial institution's primary overdraft protection plan.
secondary	overdraftProtectionElection Describes whether an account holder elected for the account to participate in the financial institution's secondary overdraft protection plan. This value is only set if the financial institution offers a secondary overdraft protection plan.

overdraftProtectionPatch

{
  "items": [
    {
      "id": "da1331a9e9168ea91346",
      "label": "Checking *3456",
      "maskedNumber": "*3456"
    },
    {
      "id": "5c9b4e50a0401ef4eb2e",
      "label": "Premiere Savings *1234",
      "maskedNumber": "*1234"
    }
  ]
}

Overdraft Protection Patch (v1.1.2)

Representation of request used to patch the overdraft protection settings consisting of a list of overdraft protection accounts linked to the account identified by the {accountId}. Note that changes to elections for the primary or secondary overdraft protection plans is done with the setOverdraftProtectionElections operation.

Properties

Name	Description
Overdraft Protection Patch (v1.1.2)	object Representation of request used to patch the overdraft protection settings consisting of a list of overdraft protection accounts linked to the account identified by the {accountId}. Note that changes to elections for the primary or secondary overdraft protection plans is done with the setOverdraftProtectionElections operation.
accounts	array: [overdraftAccountItem] The ordered list of accounts assigned as overdraft protection sweep accounts. This array is limited to no more than maximumOverdraftAccounts accounts. unique items maxItems: 4 items: object

overdraftProtectionPolicies

{
  "secondaryOffered": true,
  "secondaryIndependentOfPrimary": true,
  "secondaryElectionRequiresPrimaryElection": true,
  "primaryWithdrawalRequiresSecondaryWithdrawal": true
}

Overdraft Protection Policies (v1.0.0)

The financial institutions policies which govern how the banking customer may elect or withdraw enrollment in the primary and/or secondary Overdraft Protection plans, if these are offered at the financial institution.

Properties

Name	Description
Overdraft Protection Policies (v1.0.0)	object The financial institutions policies which govern how the banking customer may elect or withdraw enrollment in the primary and/or secondary Overdraft Protection plans, if these are offered at the financial institution.
secondaryOffered	boolean (required) If true, the financial institution offers a secondary overdraft protection plan for some banking products and accounts.
secondaryIndependentOfPrimary	boolean (required) If true: when a banking customer elects to enroll an account in the primary overdraft protection plan, the account is not automatically enrolled in the secondary overdraft protection plan, and * when a banking customer elects to withdraw an account from the primary overdraft protection plan, the account is not automatically withdrawn from the secondary overdraft protection plan. Always false if secondaryOffered is false.
secondaryElectionRequiresPrimaryElection	boolean (required) If true, when a banking customer elects to enroll in the secondary overdraft protection plan for an account, they must elect to enroll in the primary overdraft protection plan. Always false if secondaryOffered is false. Always false if secondaryOffered is false.
primaryWithdrawalRequiresSecondaryWithdrawal	boolean (required) If the user withdraws their election for (opts out of) the primary overdraft protection plan, the election for the secondary plan is also be withdrawn. Always false if secondaryOffered is false.

paymentDue

{
  "amount": "412.78",
  "dueOn": "2025-04-01"
}

Payment Due (v1.0.2)

The payment due on an account.

Properties

Name	Description
Payment Due (v1.0.2)	object The payment due on an account. Unevaluated Properties: false
amount	creditOrDebitValue(decimal) The amount that is due on the account. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
dueOn	date(date) The due date for the amount due, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10

paymentPastDue

{
  "amount": "412.78",
  "pastDueOn": "2025-04-01"
}

Payment Past Due (v1.0.0)

The past due payment on an account.

Properties

Name	Description
Payment Past Due (v1.0.0)	object The past due payment on an account. Unevaluated Properties: false
amount	monetaryValue(decimal) The amount that is past due on the account. format: decimal maxLength: 16 pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
pastDueOn	date(date) The original due date of the past-due amount, in RFC 3339 YYYY-MM-DD date format. format: date minLength: 10 maxLength: 10

peerAccount

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "id": "211683072e1d6c05d9bb",
  "label": "Phil's checking",
  "state": "active",
  "creditUnion": {
    "maskedMemberNumber": "*02",
    "suffix": "C001"
  },
  "allows": {
    "transferTo": true,
    "transferFrom": false,
    "delete": false,
    "archive": true,
    "patch": true,
    "replace": true
  },
  "createdAt": "2024-03-21T07:56:02.375Z",
  "hasPendingTransfers": true,
  "hasFailedTransfers": false
}

Peer Account (v2.0.2)

A peer account resource - an account held by a peer at the same financial institution. This object has only one of the bankAccount or creditUnionAccount properties.

Properties

Name	Description
Peer Account (v2.0.2)	object A peer account resource - an account held by a peer at the same financial institution. This object has only one of the bankAccount or creditUnionAccount properties.
createdAt	readOnlyTimestamp(date-time) (required) The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
id	resourceId (required) The unique identifier for this peer account resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
state	peerAccountState (required) Peer account state peerAccountState strings may have one of the following enumerated values: Value Description active Active: The account is active and eligible for transfers archived Archived: The customer/member has archived this peer account. enum values: active, archived
label	string(text) (required) The human-readable label for this peer account. This is either the nickname (if assigned), or the name of the account's product type concatenated with the masked account/member number. read-only format: text maxLength: 50
firstName	string(text) (required) The account holder's first name. format: text maxLength: 24
lastName	string(text) (required) The account holder's last name. format: text maxLength: 24
nickname	accountNickname(text) (required) A nickname for this account. format: text maxLength: 50
type	peerAccountProductType (required) The type (or category) of banking product. peerAccountProductType strings may have one of the following enumerated values: Value Description savings Savings: Savings Account checking Checking: Checking Account loan Loan: Loan Account enum values: savings, checking, loan
allows	peerAccountPermissions (required) Flags which indicate the permissions the current authorized user has on this peer account resource.
bank	bankPeerAccount A peer account for a bank financial institution. Note: The full account number is omitted unless the request includes the ?unmasked=true query parameter.
creditUnion	creditUnionPeerAccount A peer account within a credit union financial institution. Note: The full member number and suffix are omitted unless the request includes the ?unmasked=true query parameter.
hasPendingTransfers	boolean (required) If true, then there are one or more pending (scheduled) transfers involving this peer account.
hasFailedTransfers	boolean (required) If true, then there are one or more failed transfers involving this peer account. This indicates the properties such as the bank.fullAccountNumber or creditUnion.fullMemberNumber may be incorrect and require attention.

peerAccountItem

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "id": "211683072e1d6c05d9bb",
  "state": "active",
  "label": "Phil's checking",
  "createdAt": "2024-03-21T07:56:02.375Z"
}

Peer Account Item (v2.0.1)

Summary representation of a peer account resource. To fetch the full representation of this peer account, use the getPeerAccount operation, passing this item's id field as the peerAccountId path parameter.

Properties

Name	Description
Peer Account Item (v2.0.1)	object Summary representation of a peer account resource. To fetch the full representation of this peer account, use the getPeerAccount operation, passing this item's id field as the peerAccountId path parameter.
createdAt	readOnlyTimestamp(date-time) (required) The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
id	resourceId (required) The unique identifier for this peer account resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
state	peerAccountState (required) Peer account state peerAccountState strings may have one of the following enumerated values: Value Description active Active: The account is active and eligible for transfers archived Archived: The customer/member has archived this peer account. enum values: active, archived
label	string(text) (required) The human-readable label for this peer account. This is either the nickname (if assigned), or the name of the account's product type concatenated with the masked account/member number. read-only format: text maxLength: 50
firstName	string(text) (required) The account holder's first name. format: text maxLength: 24
lastName	string(text) (required) The account holder's last name. format: text maxLength: 24
nickname	accountNickname(text) (required) A nickname for this account. format: text maxLength: 50
type	peerAccountProductType (required) The type (or category) of banking product. peerAccountProductType strings may have one of the following enumerated values: Value Description savings Savings: Savings Account checking Checking: Checking Account loan Loan: Loan Account enum values: savings, checking, loan

peerAccountPatch

{
  "nickname": "Martin's college allowance checking"
}

Peer Account Patch (v1.0.0)

Request data to patch a peer account.

Properties

Name	Description
Peer Account Patch (v1.0.0)	object Request data to patch a peer account.
nickname	string(text) | null An optional nickname for this account. format: text maxLength: 50 nullable

peerAccountPermissions

{
  "transferFrom": true,
  "transferTo": true,
  "delete": true,
  "archive": true,
  "patch": true,
  "replace": true
}

Peer Account Permissions (v1.1.1)

Flags which indicate the permissions the current authorized user has on this peer account resource.

Properties

Name	Description
Peer Account Permissions (v1.1.1)	object Flags which indicate the permissions the current authorized user has on this peer account resource.
transferFrom	boolean (required) If true, the customer may use this peer account as the source (debit) account for account-to-account transfers.
transferTo	boolean (required) If true, the customer may use this peer account as the target (deposit) account for account-to-account transfers.
delete	boolean (required) If true, the user may delete this instance. If false, the user should resolve conflicts (such as canceling any transfers that involve the peer account) or archive the account instead.
archive	boolean (required) If true, the user may archive this instance using the archivePeerAccount operation.
patch	boolean (required) If true, the user may patch this resource using the patchPeerAccount operation.
replace	boolean (required) If true, the user may replace this peer account using the replacePeerAccount operation.

peerAccountProductType

"savings"

Peer Account Product Type (v1.0.0)

The type (or category) of banking product.

peerAccountProductType strings may have one of the following enumerated values:

Value	Description
savings	Savings: Savings Account
checking	Checking: Checking Account
loan	Loan: Loan Account

type: string

enum values: savings, checking, loan

peerAccountReplacement

{
  "firstName": "Phil",
  "lastName": "Chase",
  "nickname": "Phil's checking",
  "type": "checking",
  "creditUnion": {
    "fullMemberNumber": "4002",
    "suffix": "C001"
  }
}

Peer Account Replacement (v1.1.0)

Representation used to replace key account identification properties of a peer account. The object must contain either bank or creditUnion properties (but not both).

Properties

Name	Description
Peer Account Replacement (v1.1.0)	object Representation used to replace key account identification properties of a peer account. The object must contain either bank or creditUnion properties (but not both).
firstName	string(text) The account holder's first name. format: text maxLength: 24
lastName	string(text) The account holder's last name. format: text maxLength: 24
nickname	accountNickname(text) A nickname for this account. format: text maxLength: 50
type	peerAccountProductType The type (or category) of banking product. peerAccountProductType strings may have one of the following enumerated values: Value Description savings Savings: Savings Account checking Checking: Checking Account loan Loan: Loan Account enum values: savings, checking, loan
bank	bankPeerAccountReplacement Identifies a new peer account at a bank.
creditUnion	creditUnionPeerAccountReplacement Identifies a new peer account at a credit union.

peerAccountState

"active"

Peer Account State (v1.0.0)

Peer account state

peerAccountState strings may have one of the following enumerated values:

Value	Description
active	Active: The account is active and eligible for transfers
archived	Archived: The customer/member has archived this peer account.

type: string

enum values: active, archived

peerAccounts

{
  "maximumPeerAccounts": 15,
  "totalCount": 2,
  "items": [
    {
      "id": "211683072e1d6c05d9bb",
      "firstName": "Phil",
      "lastName": "Chase",
      "nickname": "Phil's checking",
      "label": "Phil's checking",
      "state": "active",
      "type": "checking",
      "createdAt": "2024-03-21T07:56:02.375Z"
    },
    {
      "id": "5a7a84543f3328c96389",
      "firstName": "Sally",
      "lastName": "Chase",
      "nickname": "Sally's savings",
      "label": "Sally's savings",
      "state": "active",
      "type": "savings",
      "createdAt": "2024-03-21T07:56:02.375Z"
    }
  ]
}

Peer Account Collection (v2.0.1)

A list of the customer's/member's peer accounts. There is no default sort order for the items. This list is not paginated. The number of items is the number of accounts that match the filter criteria. The totalCount is the customer/member's total number of peer accounts, ignoring any filters.

Properties

Name	Description
Peer Account Collection (v2.0.1)	object A list of the customer's/member's peer accounts. There is no default sort order for the items. This list is not paginated. The number of items is the number of accounts that match the filter criteria. The totalCount is the customer/member's total number of peer accounts, ignoring any filters.
totalCount	integer(int32) (required) The customer/member's total number of peer accounts, ignoring any filters. The financial institution limits the number of peer accounts each customer/member may have (usually 15, but no more than 100). format: int32 minimum: 0 maximum: 100
maximumPeerAccounts	integer(int32) (required) The maximum number of peer accounts the customer/member can create. Attempts to create a new peer account fail if the totalCount of peer accounts is equal to this maximum. format: int32 minimum: 0 maximum: 100
items	array: [peerAccountItem] (required) An array containing a list of peer account items. maxItems: 100 items: object

pendingAccountVerificationLetter

{}

Pending Account Verification Letter (v1.0.0)

Response when an account verification letter is pending but not yet available. There are no properties in this object response.

Properties

Name	Description
Pending Account Verification Letter (v1.0.0)	object Response when an account verification letter is pending but not yet available. There are no properties in this object response.

positiveTwoDecimalRate

"120.50"

Positive Rate (v1.0.0)

A positive rate, expressed as a percentage value with two decimal places of precision. Values may range from 0.00 to 999.99 inclusive.

type: string(decimal)

format: decimal
minLength: 4
maxLength: 6
pattern: "^(0|[1-9]\d{0,2})\.\d{2}$"

primaryBalance

{
  "balance": "3208.20",
  "label": "Available",
  "description": "The amount of money available for use, typically the previous day's closing balance plus or minus any pending transactions"
}

Primary Balance (v1.0.1)

The primary balance of an account.

Properties

Name	Description
Primary Balance (v1.0.1)	object The primary balance of an account. Unevaluated Properties: false
label	string(text) (required) The human-readable label for the balance. format: text minLength: 1 maxLength: 50
description	string(text) (required) The human-readable description of the balance. format: text minLength: 1 maxLength: 500
balance	creditOrDebitValue(decimal) (required) The primary balance of the account. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://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://api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.2)

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

Properties

Name	Description
Problem Response (v0.4.2)	object API problem or error response, as per RFC 9457 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problems with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object
attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

productAllows

{
  "manuallyRefreshBalance": true
}

Product Allows (v1.0.0)

Indicates what actions are allowed for the product type.

Properties

Name	Description
Product Allows (v1.0.0)	object Indicates what actions are allowed for the product type.
manuallyRefreshBalance	boolean (required) If true, the customer may refresh balances on accounts of the product type.

productCustomerType

"personal"

Product Customer Type (v1.0.0)

Indicates the type of customer that uses this banking product: personal (retail) or business (commercial).

productCustomerType strings may have one of the following enumerated values:

Value	Description
personal	Personal: Retail banking products for personal customers
business	Business: Commercial banking products for business customers
both	Personal and Business: Banking products for personal or business customers

type: string

enum values: personal, business, both

productItem

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

Product Item (v2.0.0)

Details of one banking account in a collection of accounts.

Properties

Name	Description
Product Item (v2.0.0)	object Details of one banking account in a collection of accounts. Unevaluated Properties: false
type	productType (required) The type of account. enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings, other
coreType	string (required) The account product type in the banking core. For example, some cores may use "D" for a demand deposit (checking) account, some may use "DDA". minLength: 1 maxLength: 4 pattern: "^[A-Z0-9]{1,4}$"
code	string(text) (required) The product's product code which uniquely identifies the product from other banking products. Codes are unique to the financial institution. For example, different products with the same type and the same coreType but different rates or other properties have different product codes, such as CD3M, DDA_HI_YLD, P3207. format: text minLength: 1 maxLength: 16
label	string(text) (required) A human-readable label for this banking product. format: text minLength: 2 maxLength: 48
description	string(markdown) A human-readable description of this banking product. format: markdown minLength: 2 maxLength: 400
allows	productAllows (required) Indicates what actions are allowed for the product type.

productType

"savings"

Product Type (v2.3.0)

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

Value	Description
savings	Savings: Savings Account
checking	Checking: Checking Account
cd	CD: Certificate of Deposit Account
ira	IRA: Individual Retirement Account
loan	Loan: Loan Account
creditCard	Credit Card: Credit Card Account
moneyMarket	Money Market: Money Market Account
healthSavings	Health Savings: Health Savings Account
other	Other: Other Account

type: string

enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings, other

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

realTimePaymentAccountAllowsFilter

"realTimePaymentFrom"

Account Allows Filter (v1.0.0)

Values for the ?allows= filter in listEligibleRealTimePaymentAccounts.

realTimePaymentAccountAllowsFilter strings may have one of the following enumerated values:

Value	Description
realTimePaymentFrom	Real-Time Payments From: Include each account where the caller is allowed to send credit real-time payments.
realTimePaymentTo	Real-Time Payments To: Include each account where the caller is allowed to receive debit real-time payments.

type: string

enum values: realTimePaymentFrom, realTimePaymentTo

realTimePaymentAccountItem

{
  "id": "bf23bc970b78d27691e8",
  "location": "internal",
  "nickname": "Payroll Checking",
  "label": "Payroll Checking *1008",
  "maskedNumber": "*1008",
  "allows": {
    "realTimePaymentFrom": true,
    "realTimePaymentTo": true
  }
}

Real-Time Payment Account Item (v1.0.2)

A real-time payment account item in a list of items in the realTimePaymentAccounts schema.

Properties

Name	Description
Real-Time Payment Account Item (v1.0.2)	object A real-time payment account item in a list of items in the realTimePaymentAccounts schema.
id	resourceId (required) The unique identifier for this account resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	accountLabel(text) (required) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. read-only format: text minLength: 1 maxLength: 80
nickname	accountNickname(text) 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. format: text maxLength: 50
maskedNumber	maskedAccountNumber (required) A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber. minLength: 2 maxLength: 5 pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
fullAccountNumber	fullAccountNumber The full unmasked account number or member number. Note: This is omitted unless the request includes the ?unmasked=true query parameter. Such requests are auditable. minLength: 1 maxLength: 32 pattern: "^[- a-zA-Z0-9.]{1,32}$"
location	accountLocation (required) Indicates where an account is held. enum values: internal, external, outside, peer
allows	realTimePaymentAccountPermissions (required) Flags which indicate the permissions the current authorized user has on this real-time payment account item resource. Most of these properties may only be true for internal accounts. These permissions are available in account items in the realTimePaymentAccounts list. See fullAccountPermissions for all capabilities a customer has on an account (the account.allows object in the account object response from getAccount.)
overdraftProtectionElections	overdraftProtectionElections Describes whether the account holder elected primary or secondary overdraft protection for the account and when those elections were last updated. Note: this property is only returned in account list items if the listAccounts request query parameter ?allows= includes manageOverdraftProtectionElections.

realTimePaymentAccountPermissions

{
  "realTimePaymentFrom": true,
  "realTimePaymentTo": true
}

Real-Time Payment Account Permissions (v1.0.0)

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

Properties

Name	Description
Real-Time Payment Account Permissions (v1.0.0)	object Flags which indicate the permissions the current authorized user has on this real-time payment account item resource. Most of these properties may only be true for internal accounts. These permissions are available in account items in the realTimePaymentAccounts list. See fullAccountPermissions for all capabilities a customer has on an account (the account.allows object in the account object response from getAccount.)
realTimePaymentFrom	boolean (required) If true, the customer may use this account to send credit real-time payments.
realTimePaymentTo	boolean (required) If true, the customer may use this account to receive debit real-time payments.

realTimePaymentAccounts

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100?allows=view",
  "count": 6,
  "items": [
    {
      "id": "bf23bc970b78d27691e8",
      "nickname": "Payroll Checking",
      "label": "Payroll Checking *1008",
      "maskedNumber": "*1008",
      "location": "internal",
      "allows": {
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    },
    {
      "id": "b78d27691e8bf23bc970",
      "nickname": "College CD",
      "label": "College CD *2017",
      "maskedNumber": "*2017",
      "location": "internal",
      "allows": {
        "realTimePaymentFrom": true,
        "realTimePaymentTo": true
      },
      "overdraftProtectionElections": {
        "primary": {
          "election": true,
          "lastUpdatedAt": "2024-03-04T04:05:24.375Z"
        },
        "secondary": {
          "election": false
        }
      }
    }
  ]
}

Real-Time Payment Accounts (v1.0.2)

A paginated list of the customer's real-time payment accounts. This list contains internal banking accounts and external banking accounts. and outside fund accounts. The location property indicates where the account is held. Items in the list contain url links to the actual account resource which are in the accounts, externalAccounts or outsideAccounts collections.

Properties

Name	Description
Real-Time Payment Accounts (v1.0.2)	object A paginated list of the customer's real-time payment accounts. This list contains internal banking accounts and external banking accounts. and outside fund accounts. The location property indicates where the account is held. Items in the list contain url links to the actual account resource which are in the accounts, externalAccounts or outsideAccounts collections.
limit	integer(int32) (required) The number of items requested for this page response. The length of the items array may be less that limit. format: int32 minimum: 0 maximum: 10000
nextPage_url	string(uri-reference) The URL of the next page of real-time payment accounts. If this URL is omitted, there are no more accounts. read-only format: uri-reference maxLength: 256
start	string(text) The opaque cursor that specifies the starting location of this page of items. format: text maxLength: 256
items	array: [realTimePaymentAccountItem] (required) The array of items in this page of real-time payment accounts. This array may be empty. read-only maxItems: 1000 items: object
count	integer(int32) The total number of real-time payment accounts for which the user has access. This value ignores any filters. This value is optional and may be omitted if the count is not computable efficiently. format: int32 minimum: 0 maximum: 25000
primaryAccountId	resourceId The id of the customer's primary real-time payment account. This property only exists for retail customers, and only if the customer has designated a primary account. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

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.3.1)

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 403 Forbidden problem response when the 403 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

Name	Description
Required Challenge (v1.3.1)	object 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 403 Forbidden problem response when the 403 problem type name is challengeRequired. See the "Challenge API" for details.
operationId	challengeOperationId (required) 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. minLength: 6 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{6,48}$"
challengeId	readOnlyResourceId (required) The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
factors	array: [challengeFactor] (required) A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor. minItems: 1 maxItems: 8 items: object
challengeText	identityChallengeText Optional text to display during an identity challenge user experience. All text fields are optional. If present, the text overrides default text defined by the system or financial institution. The text values may be HTML or plain text. Unevaluated Properties: false

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

secondaryBalance

{
  "balance": "2253.22",
  "label": "Current",
  "description": "Total account value including principal and earned interest"
}

Secondary Balance (v1.0.1)

The secondary balance of an account.

Properties

Name	Description
Secondary Balance (v1.0.1)	object The secondary balance of an account. Unevaluated Properties: false
label	string(text) (required) The human-readable label for the balance. format: text minLength: 1 maxLength: 50
description	string(text) (required) The human-readable description of the balance. format: text minLength: 1 maxLength: 500
balance	creditOrDebitValue(decimal) (required) The secondary balance of the account. format: decimal maxLength: 16 pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

simpleAccountAlertSubscription

{
  "enabled": true,
  "communicationChannels": [
    {
      "id": "0399abed-fd3d",
      "label": "Max.Pike@example.com",
      "type": "email"
    }
  ]
}

Simple Account Alert Subscription (v1.0.2)

A card alert subscription configuration based on an enabled flag and communication channels.

Properties

Name	Description
Simple Account Alert Subscription (v1.0.2)	object A card alert subscription configuration based on an enabled flag and communication channels. Unevaluated Properties: false
enabled	boolean (required) If true, the alert is enabled.
communicationChannels	array: [accountAlertCustomerCommunicationChannel] (required) Channels to communicate this alert subscription. unique items minItems: 0 maxItems: 5 items: object » Unevaluated Properties: false

transferAccountReference

{
  "id": "e821ce54-c715",
  "label": "Premiere Checking *6789",
  "type": "checking",
  "location": "internal"
}

Transfer Account Reference (v3.0.0)

A reference to a banking account used within an account to account transfer. This object may be set from an account's account.reference object.

Properties

Name	Description
Transfer Account Reference (v3.0.0)	object A reference to a banking account used within an account to account transfer. This object may be set from an account's account.reference object.
id	resourceId (required) The unique ID of a banking account. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
label	accountLabel1(text) The human-readable label for this account. This is either the nickname (if assigned for the current customer), or the product.label concatenated with the maskedNumber. format: text minLength: 1 maxLength: 80
type	productType The product type of the account. enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings, other
location	accountLocation Indicates where an account is held. enum values: internal, external, outside, peer

twoDecimalInterestRate

"1.40"

Two Decimal Interest Rate (v1.0.1)

An interest rate, expressed as a percentage value with two decimal places of precision.

type: string(decimal)

format: decimal
minLength: 4
maxLength: 7
pattern: "^(-|\+)?(0|[1-9]\d?)\.\d{2}$"

usRequestAddress

{
  "address1": "1805 Tiburon Dr.",
  "address2": "Building 14, Suite 1500",
  "locality": "Wilmington",
  "regionCode": "NC",
  "countryCode": "US",
  "postalCode": "28412"
}

Request Address (United States) (v1.0.0)

A postal address within the United States or US territories, used in API request bodies.

Properties

Name	Description
Request Address (United States) (v1.0.0)	object A postal address within the United States or US territories, used in API request bodies.
address1	string(text) (required) The first line of the postal address. In the US, this typically includes the building number and street name. format: text maxLength: 30
address2	string(text) The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address. format: text maxLength: 30
locality	string(text) (required) The city/town/municipality of the address. format: text maxLength: 30
countryCode	countryCode (required) The ISO-3611 alpha-2 value for a country. minLength: 2 maxLength: 2 pattern: "^[A-Za-z]{2}$"
regionCode	string (required) The state, district, or outlying area of the postal address. minLength: 2 maxLength: 2 pattern: "^[A-Za-z]{2}$"
postalCode	string (required) A group of five or nine numbers that are added to a postal address to assist the sorting of mail. minLength: 5 maxLength: 10 pattern: "^\\d{5}(?:[- ]?\\d{4})?$"

usResponseAddress

{
  "address1": "1805 Tiburon Dr.",
  "address2": "Building 14, Suite 1500",
  "locality": "Wilmington",
  "regionCode": "NC",
  "countryCode": "US",
  "postalCode": "28412"
}

Response Address (United States) (v1.0.0)

A postal address within the United States or US territories, used in API responses.

Properties

Name	Description
Response Address (United States) (v1.0.0)	object A postal address within the United States or US territories, used in API responses.
address1	string(text) (required) The first line of the postal address. In the US, this typically includes the building number and street name. format: text maxLength: 35
address2	string(text) The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address. format: text maxLength: 35
locality	string(text) (required) The city/town/municipality of the address. format: text maxLength: 30
countryCode	countryCode (required) The ISO-3611 alpha-2 value for a country. minLength: 2 maxLength: 2 pattern: "^[A-Za-z]{2}$"
regionCode	string (required) The state, district, or outlying area of the postal address. minLength: 2 maxLength: 2 pattern: "^[A-Za-z]{2}$"
postalCode	string (required) A group of five or nine numbers that are added to a postal address to assist the sorting of mail. minLength: 5 maxLength: 10 pattern: "^\\d{5}(?:[- ]?\\d{4})?$"

---