Institutions v0.31.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.

Operations related to bank and credit union financial institutions (FIs). This API provides the following features

Calculating upcoming dates for transfer schedules, factoring in weekends, non-business days, and banking holidays as determined by the institution,
Provide a list of transfer date restrictions: dates when users should not schedule transfers, based on transfer parameters,
Look up a financial institution by an FI locator value: either an ABA routing and transit number, an IBAN account number, or a SWIFT/BIC code,
Fetching Cutoff times for FI money movement requests.
Searching branch and ATM locations
Configurations for institutions and their features

Some of the operations in this API require an institutionId path parameter. This is the unique alphanumeric code that uniquely identifies a financial institution.

Download OpenAPI Definition (YAML)

Base URLs:

https://api.apiture.com/banking

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

Institutions

Banking Institutions

listAccessLocationsForInstitution

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/institutions/{institutionId}/accessLocations?radius=string \
  -H 'Accept: application/json' \
  -H 'Accept-Language: string'

GET https://api.apiture.com/banking/institutions/{institutionId}/accessLocations?radius=string HTTP/1.1
Host: api.apiture.com
Accept: application/json
Accept-Language: string

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

const headers = {
  'Accept':'application/json',
  'Accept-Language':'string'

};

fetch('https://api.apiture.com/banking/institutions/{institutionId}/accessLocations?radius=string',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Accept-Language':'string'

};

$.ajax({
  url: 'https://api.apiture.com/banking/institutions/{institutionId}/accessLocations',
  method: 'get',
  data: '?radius=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Accept-Language' => 'string'
}

result = RestClient.get 'https://api.apiture.com/banking/institutions/{institutionId}/accessLocations',
  params: {
  'radius' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Accept-Language': 'string'
}

r = requests.get('https://api.apiture.com/banking/institutions/{institutionId}/accessLocations', params={
  'radius': 'string'
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Accept-Language": []string{"string"},
        
    }

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

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

Look up financial institution access locations

GET https://api.apiture.com/banking/institutions/{institutionId}/accessLocations

Returns a collection of financial institution access locations.

An institution access location is a physical location that allows customers or members to conduct banking and use banking services not available through digital channels. An institution access location can be either a branch or an automated teller machine (ATM). Branches consist of a lobby, and may contain an ATM, and/or a drive through. Branches may also have private offices and/or safe deposit boxes. An ATM is a standalone terminal for accessing accounts. Some ATMs allow self-service features, including bill pay and transfers. When a branch has an ATM, the ATM is not listed as a separate location.

Parameters

Parameter	Description
`institutionId` `in: path`	`institutionId` (required) The unique identifier of this institution. `minLength: 2` `maxLength: 8` `pattern: "^[A-Z0-9_]{2,8}$"`
`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`
`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`
`type` `in: query`	`array[string]` Return only institution access locations whose type matches any of the items in this pipe-separated list. All institution access location types are included when this parameter is excluded. `unique items` `minItems: 1` `maxItems: 2` `pipe-delimited` items: `string` » enum values: `atm`, `branch`
`postalCode` `in: query`	`postalCode` The postal code used for filtering institution access location searches. A coordinate from the geographic center of the postal code is the starting point for building a circular geographic search area. This must be included if `latitude` and `longitude` are not present. `minLength: 2` `maxLength: 20` `pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"`
`countryCode` `in: query`	`any` The country code associated with the postal code for filtering financial institution access location searches. `default: "US"`
`latitude` `in: query`	`any` The Earth latitude coordinate for building a circular geographic search area. This must be included if `postalCode` is not present.
`longitude` `in: query`	`any` The Earth longitude coordinate for building a circular geographic search area. This must be included if `postalCode` is not present.
`radius` `in: query`	`string` (required) The radius of the circular geographic search area for financial institution access locations to include. The unit of measurement may be included after the distance value. Use `mi` for miles and `km` for kilometers. When a unit of measurement is not included, the default unit is miles. For example: `&radius=25mi` (25 miles) or `&radius=40km` (40 km) or `&radius=20.25` (20.25 miles) or `&radius=25` (25 miles) The maximum distance when using miles is 500 miles. The maximum distance when using kilometers is 805 kilometers. `minLength: 1` `maxLength: 8` `pattern: "^\\d{1,3}(\\.\\d{1,2})?(mi\|km)?$"`

Example responses

200 Response

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/institutionAccessLocations/?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "count": 2381,
  "items": [
    {
      "name": "Tiburon Financial ATM",
      "type": "atm",
      "location": {
        "address": {
          "address1": "1805 Tiburon Drive",
          "locality": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28403",
          "countryCode": "US"
        },
        "coordinates": {
          "latitude": 34.20085,
          "longitude": -77.90288
        }
      },
      "distance": "6.21mi",
      "hoursOfOperation": {
        "atm": {
          "sunday": {
            "open24Hours": true
          },
          "monday": {
            "open24Hours": true
          },
          "tuesday": {
            "open24Hours": true
          },
          "wednesday": {
            "open24Hours": true
          },
          "thursday": {
            "open24Hours": true
          },
          "friday": {
            "open24Hours": true
          },
          "saturday": {
            "open24Hours": true
          }
        }
      },
      "atm": {
        "selfService": true
      }
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `institutionAccessLocations`

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Status	Description
404	Not Found
	Not found. There is no such resource at the request URL. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/notFound/v1.0.0` The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.
	Schema: `Inline`

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidLocationParameters/v1.0.0
Only one type of location parameter may be included or a location parameter is missing a value. Remediation: Provide correct location parameters.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.

listInstitutionAccessLocations

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/institutionAccessLocations?radius=string \
  -H 'Accept: application/json' \
  -H 'Accept-Language: string' \
  -H 'API-Key: API_KEY'

GET https://api.apiture.com/banking/institutionAccessLocations?radius=string HTTP/1.1
Host: api.apiture.com
Accept: application/json
Accept-Language: string

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

const headers = {
  'Accept':'application/json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

fetch('https://api.apiture.com/banking/institutionAccessLocations?radius=string',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Accept-Language' => 'string',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.apiture.com/banking/institutionAccessLocations',
  params: {
  'radius' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Accept-Language': 'string',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.apiture.com/banking/institutionAccessLocations', params={
  'radius': 'string'
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Accept-Language": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

~~Look up financial institution access locations~~

~~GET https://api.apiture.com/banking/institutionAccessLocations~~

deprecated
Returns a collection of financial institution access locations.

Either postalCode or coordinate set (latitude and longitude) is required to set the central point for the circular geographic search area, extending from the central point to the radius in all directions. The radius allows a unit of measurement to be specified. Miles (mi) and kilometers (km) are the allowed units. Miles are the default unit when one isn't specified.
Warning: The operation listInstitutionAccessLocations was deprecated on version v0.25.0 of the API. Use the listAccessLocationsForInstitution operation instead. listInstitutionAccessLocations will be removed on version v0.35.0 of the API.

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`
`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`
`type` `in: query`	`array[string]` Return only institution access locations whose type matches any of the items in this pipe-separated list. All institution access location types are included when this parameter is excluded. `unique items` `minItems: 1` `maxItems: 2` `pipe-delimited` items: `string` » enum values: `atm`, `branch`
`postalCode` `in: query`	`postalCode` The postal code used for filtering institution access location searches. A coordinate from the geographic center of the postal code is the starting point for building a circular geographic search area. This must be included if `latitude` and `longitude` are not present. `minLength: 2` `maxLength: 20` `pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"`
`countryCode` `in: query`	`any` The country code associated with the postal code for filtering financial institution access location searches. `default: "US"`
`latitude` `in: query`	`any` The Earth latitude coordinate for building a circular geographic search area. This must be included if `postalCode` is not present.
`longitude` `in: query`	`any` The Earth longitude coordinate for building a circular geographic search area. This must be included if `postalCode` is not present.
`radius` `in: query`	`string` (required) The radius of the circular geographic search area for financial institution access locations to include. The unit of measurement may be included after the distance value. Use `mi` for miles and `km` for kilometers. When a unit of measurement is not included, the default unit is miles. For example: `&radius=25mi` (25 miles) or `&radius=40km` (40 km) or `&radius=20.25` (20.25 miles) or `&radius=25` (25 miles) The maximum distance when using miles is 500 miles. The maximum distance when using kilometers is 805 kilometers. `minLength: 1` `maxLength: 8` `pattern: "^\\d{1,3}(\\.\\d{1,2})?(mi\|km)?$"`

Example responses

200 Response

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/institutionAccessLocations/?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "count": 2381,
  "items": [
    {
      "name": "Tiburon Financial ATM",
      "type": "atm",
      "location": {
        "address": {
          "address1": "1805 Tiburon Drive",
          "locality": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28403",
          "countryCode": "US"
        },
        "coordinates": {
          "latitude": 34.20085,
          "longitude": -77.90288
        }
      },
      "distance": "6.21mi",
      "hoursOfOperation": {
        "atm": {
          "sunday": {
            "open24Hours": true
          },
          "monday": {
            "open24Hours": true
          },
          "tuesday": {
            "open24Hours": true
          },
          "wednesday": {
            "open24Hours": true
          },
          "thursday": {
            "open24Hours": true
          },
          "friday": {
            "open24Hours": true
          },
          "saturday": {
            "open24Hours": true
          }
        }
      },
      "atm": {
        "selfService": true
      }
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `institutionAccessLocations`

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Status	Description
404	Not Found
	Not found. There is no such resource at the request URL. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/notFound/v1.0.0` The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.
	Schema: `Inline`

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidLocationParameters/v1.0.0
Only one type of location parameter may be included or a location parameter is missing a value. Remediation: Provide correct location parameters.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.

lookUpInstitutionByLocator

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/institutionByLocator?locator=string&locatorType=abaRoutingNumber&countryCode=US \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/institutionByLocator?locator=string&locatorType=abaRoutingNumber&countryCode=US 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/institutionByLocator?locator=string&locatorType=abaRoutingNumber&countryCode=US',
{
  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/institutionByLocator',
  method: 'get',
  data: '?locator=string&locatorType=abaRoutingNumber&countryCode=US',
  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/institutionByLocator',
  params: {
  'locator' => 'string(text)',
'locatorType' => '[institutionLocatorType](#schema-institutionLocatorType)',
'countryCode' => '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/institutionByLocator', params={
  'locator': 'string',  'locatorType': 'abaRoutingNumber',  'countryCode': 'US'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/institutionByLocator?locator=string&locatorType=abaRoutingNumber&countryCode=US");
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/institutionByLocator", data)
    req.Header = headers

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

Look up institution by routing number, IBAN, or SWIFT/BIC code

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

Look up a financial institution by their country code and either American Bankers Association routing number, by International Bank Account Number (IBAN), or by SWIFT Business Identifier Code (BIC) code. Optionally, include a list of intermediary institutions that may be necessary to complete international wire transfers.

Parameters

Parameter	Description
`locator` `in: query`	`string(text)` (required) The financial institution lookup key (routing number, IBAN, or SWIFT/BIC), as indicated by the `locatorType` query parameter. `format: text` `maxLength: 36`
`locatorType` `in: query`	`institutionLocatorType` (required) Indicates what type of value the `locator` query parameter is. enum values: `abaRoutingNumber`, `swiftBicCode`, `other`
`countryCode` `in: query`	`string` (required) The country code in which to search for institutions. For the US, the `locatorType` must be `abaRoutingNumber`. For non-US countries, the `locatorType` must be `swiftBicCode` or `ibanAccountNumber`. `minLength: 2` `maxLength: 2` `pattern: "^[A-Z]{2}$"`
`includeIntermediaryInstitutions` `in: query`	`boolean` If looking up a beneficiary institution for a wire transfer beneficiary institution, request the response also include a list of intermediary institutions.

Example responses

200 Response

{
  "found": true,
  "institution": {
    "name": "First Bank of Andalasia",
    "address": {
      "address1": "239 West Princess Ave.",
      "locality": "Andalasia",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28407"
    },
    "locator": "503000196",
    "locatorType": "abaRoutingNumber"
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `institutionLookupResult`

Status Description

400 Bad Request

Status	Description
400	Bad Request
	Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/badRequest/v1.0.0` The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.
	Schema: `Inline`

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Status	Description
401	Unauthorized
	Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/unauthorized/v1.0.0` The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.
	Schema: `Inline`

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Status	Description
403	Forbidden
	Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/forbidden/v1.0.0` The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation. `https://production.api.apiture.com/errors/customerDisabled/v1.0.0` The customer is disabled. Remediation: Have the customer contact the financial institution for support. `https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0` The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software. `https://production.api.apiture.com/errors/modificationForbidden/v1.0.0` The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization. `https://production.api.apiture.com/errors/challengeRequired/v1.0.0` The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call. The `attributes` object in the error may have the properties defined by the `requiredIdentityChallenge` schema. `https://production.api.apiture.com/errors/challengeBlocked/v1.0.0` The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again. `https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0` This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors. `https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0` The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
	Schema: `Inline`

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidLocator/v1.0.0
The locator value is invalid for the given locatorType. Remediation: Pass a valid ABA routing number, IBAN number, or SWIFT/BIC code, as per the given locatorType.

Schema: problemResponse

Status Description

429 Too Many Requests

Status	Description
429	Too Many Requests
	Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: `https://production.api.apiture.com/errors/tooManyRequests/v1.0.0` The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.
	Schema: `Inline`

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.

Institution Configurations

Banking Institution Configurations

getInstitutionConfiguration

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/institutions/{institutionId}/configuration \
  -H 'Accept: application/json'

GET https://api.apiture.com/banking/institutions/{institutionId}/configuration HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/banking/institutions/{institutionId}/configuration',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/banking/institutions/{institutionId}/configuration',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/banking/institutions/{institutionId}/configuration', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/institutions/{institutionId}/configuration");
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"},
        
    }

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

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

Fetch a representation of the Institution Configuration

GET https://api.apiture.com/banking/institutions/{institutionId}/configuration

Return the JSON representation of the Institution Configuration resource.

Parameters

Parameter	Description
`institutionId` `in: path`	`institutionId` (required) The unique identifier of this institution. `minLength: 2` `maxLength: 8` `pattern: "^[A-Z0-9_]{2,8}$"`

Example responses

200 Response

{
  "dataSharing": {
    "enabled": false
  },
  "identityProvider": {
    "issuer": "https://liveoakbank.auth0.com",
    "webApplication": {
      "profileManagement": {
        "label": "Profile Management",
        "url": "https://liveoakbank.auth0.com/profile"
      }
    },
    "viewOnlyProperties": [
      "primaryEmail",
      "mobilePhone"
    ]
  },
  "customerOrganizationModeling": "split",
  "bankingClient": {
    "realTimePayments": {
      "includeSender": true
    }
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `institutionConfiguration`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.

Schedules

getTransferSchedule

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/transferSchedule?startsOn=2022-07-04&direction=debit&frequency=once \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/transferSchedule?startsOn=2022-07-04&direction=debit&frequency=once 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/transferSchedule?startsOn=2022-07-04&direction=debit&frequency=once',
{
  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/transferSchedule',
  method: 'get',
  data: '?startsOn=2022-07-04&direction=debit&frequency=once',
  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/transferSchedule',
  params: {
  'startsOn' => 'string(date)',
'direction' => '[transferScheduleDirection](#schema-transferScheduleDirection)',
'frequency' => '[transferFrequency](#schema-transferFrequency)'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/banking/transferSchedule', params={
  'startsOn': '2022-07-04',  'direction': 'debit',  'frequency': 'once'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/transferSchedule?startsOn=2022-07-04&direction=debit&frequency=once");
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/transferSchedule", data)
    req.Header = headers

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

Return this institution's list of upcoming transfer schedule dates

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

Return a transfer schedule list for this institution.

Parameters

Parameter	Description
`startsOn` `in: query`	`string(date)` (required) The date to use to begin calculations of the transfer schedule in `YYYY-MM-DD` RFC 3339 date format. `format: date` `minLength: 10` `maxLength: 10`
`endsOn` `in: query`	`string(date)` The date to use to conclude calculations of the transfer schedule in `YYYY-MM-DD` RFC 3339 date format. `format: date` `minLength: 10` `maxLength: 10`
`direction` `in: query`	`transferScheduleDirection` (required) The direction of the transfer from the institution to the customer used for adjusting transfer dates due to banking holidays. For `debit`, dates are adjusted to the next business day. For `credit`, dates are adjusted to the previous business day. enum values: `debit`, `credit`, `both`
`count` `in: query`	`integer(int32)` The maximum amount of dates to calculate and include in the response. If an end date is provided, the total count may be lower than the requested count. `format: int32` `minimum: 1` `maximum: 12` `default: 6`
`frequency` `in: query`	`transferFrequency` (required) The interval at which the money movement recurs. Frequency values `once` and `occasional` result in only one date (the `startsOn` date) in the response. enum values: `once`, `occasional`, `daily`, `weekly`, `biweekly`, `semimonthly`, `monthly`, `monthlyFirstDay`, `monthlyLastDay`, `bimonthly`, `quarterly`, `semiyearly`, `yearly`
`type` `in: query`	`any` The type of transfer used to determine the `effectiveOn` date. `default: "internal"`

Example responses

200 Response

{
  "items": [
    {
      "scheduledOn": "2022-06-27",
      "effectiveOn": "2022-06-27"
    },
    {
      "scheduledOn": "2022-07-04",
      "effectiveOn": "2022-07-05"
    },
    {
      "scheduledOn": "2022-07-11",
      "effectiveOn": "2022-07-11"
    },
    {
      "scheduledOn": "2022-07-18",
      "effectiveOn": "2022-07-18"
    },
    {
      "scheduledOn": "2022-07-25",
      "effectiveOn": "2022-07-25"
    },
    {
      "scheduledOn": "2022-08-01",
      "effectiveOn": "2022-07-01"
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `transferSchedules`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status	Description
422	Unprocessable Entity
	Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.

listCutoffTimes

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/banking/cutoffTimes \
  -H 'Accept: application/json' \
  -H 'If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/cutoffTimes HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"

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

const headers = {
  'Accept':'application/json',
  'If-None-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

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

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

var headers = {
  'Accept':'application/json',
  'If-None-Match':'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'If-None-Match' => 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'W/"325cf1cc-e370-4baf-8faf-c6db23f195a2"',
  'Authorization': 'Bearer {access-token}'
}

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-None-Match": []string{"W/"325cf1cc-e370-4baf-8faf-c6db23f195a2""},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return the financial institution's cutoff times for products

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

Return daily cutoff times for different money movement processes at a financial institution. Money movement requests (account to account transfers, ACH, wire transfers, etc.) must be submitted before the cutoff time in order for the financial institution to begin processing the request that day. Some cutoff time types may have multiple cutoff times per day.

Cutoff times are very slowly changing data. This is a conditional operation when the If-None-Match header is used. If the client has a getCutoffTimes response and the ETag returned from a previous call to this operation, this operation returns a 304 Not Modified when called again if the cutoff times have not changed.

Parameters

Parameter Description

timeZoneId
in: query timeZoneId
Identifies the time zone for formatting time values in the response. If omitted, time values are formatting in the local timezone of the financial institution.
format: text
maxLength: 36

If-None-Match
in: header entityTag
The entity tag that was returned in the ETag response header of a previous call. If the resource's current entity tag value matches this header value, the GET will return 304 (Not Modified) and no response body, else the current resource representation and updated ETag is returned.
minLength: 3
maxLength: 512
pattern: "^(([\\x21\\x23-\\x7e]{1,512})|(W\\/\\\"[\\x21\\x23-\\x7e]{1,509}\\\"))$"

Example responses

200 Response

{
  "timeZoneId": "America/New_York",
  "items": [
    {
      "type": "ach",
      "time": "13:45"
    },
    {
      "type": "ach",
      "time": "16:45"
    },
    {
      "type": "sameDayAch",
      "time": "16:45"
    },
    {
      "type": "domesticWireTransfer",
      "time": "16:45"
    }
  ]
}

Responses

Status	Description
200	OK
	OK.
	Schema: `cutoffTimes`
Header	`ETag` `string`
	The value of this resource's entity tag, to be passed with `If-Match` and `If-None-Match` request headers in other conditional API calls for this resource.

Status	Description
304	Not Modified
	Not Modified. The resource has not been modified since it was last fetched.

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status	Description
422	Unprocessable Entity
	Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
	Schema: `problemResponse`

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.

listTransferDateRestrictions

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Return the financial institution's transfer dates restrictions

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

Return the transfer date restrictions for a date range and transfer parameters. The result is a list of days and dates that the financial institution does not allow scheduling specific types of transfers.

This information provides hints to clients, allowing bank customers to select transfer dates from a calendar picker. However, these dates are not strictly enforced; a transfer can still be scheduled to occur on restricted dates but the financial institution may shift the date when funds are drafted to account for holidays, closures, or to adjust based on the risk level of the funding account.

Parameters

Parameter	Description
`startsOn` `in: query`	`string(date)` The start of the range of dates to include in the response, in `YYYY-MM-DD` RFC 3339 date format. While start dates far in the future are allowed, bank holiday schedules are only available for a small number of years ahead. The default is the current date; the minimum is one week before the first of the current month. `format: date` `minLength: 10` `maxLength: 10`
`endsOn` `in: query`	`string(date)` The end of the range of dates to include in the response. in `YYYY-MM-DD` RFC 3339 date format. The default is at least one year from the `startOn` date and is limited to a four year interval. `format: date` `minLength: 10` `maxLength: 10`
`type` `in: query`	`transferTypeForDateRestrictions` Describes the type of transfer. This determines what business rules and adjustments to make to the date restrictions. Note ACH transfers (including CTX and PPD), that `Credit` and `Debit` here are relative to the account at the external financial institution. `default: "internal"` enum values: `internal`, `external`, `ach`, `achDebit`, `achCredit`, `domesticWireTransfer`, `internationalWireTransfer`
`risk` `in: query`	`achAccountRisk` The primary account's risk level. This determines what business rules and adjustments to make to the date restrictions. This parameter only applies to ACH credit transfers (funds credited to an external account) and is ignored for others. enum values: `early`, `normal`, `float`, `sameDay`

Example responses

200 Response

{
  "restrictedDates": [
    {
      "occursOn": "2022-10-01",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-02",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-03",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-04",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-05",
      "reason": "pastCutoffTime"
    },
    {
      "occursOn": "2022-10-06",
      "reason": "riskRestricted"
    },
    {
      "occursOn": "2022-10-07",
      "reason": "riskRestricted"
    },
    {
      "occursOn": "2022-10-08",
      "reason": "closure",
      "debitOn": "2022-10-07"
    },
    {
      "occursOn": "2022-10-09",
      "reason": "closure",
      "debitOn": "2022-10-07"
    },
    {
      "occursOn": "2022-10-10",
      "reason": "holiday",
      "debitOn": "2022-10-07"
    },
    {
      "occursOn": "2022-10-15",
      "reason": "closure",
      "debitOn": "2022-10-14"
    },
    {
      "occursOn": "2022-10-16",
      "reason": "closure",
      "debitOn": "2022-10-14"
    },
    {
      "occursOn": "2022-10-22",
      "reason": "closure",
      "debitOn": "2022-10-21"
    },
    {
      "occursOn": "2022-10-23",
      "reason": "closure",
      "debitOn": "2022-10-21"
    },
    {
      "occursOn": "2022-10-29",
      "reason": "closure",
      "debitOn": "2022-10-28"
    },
    {
      "occursOn": "2022-10-30",
      "reason": "closure",
      "debitOn": "2022-10-28"
    }
  ],
  "accuracyEndsOn": "2026-12-31"
}

Responses

Status	Description
200	OK
	OK.
	Schema: `transferDateRestrictions`

Status Description

400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/badRequest/v1.0.0
The request body and/or parameters was not well-formed. Remediation: Correct any syntax or schema errors in the request body or parameters.

Schema: Inline

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

404 Not Found

Not found. There is no such resource at the request URL.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/notFound/v1.0.0
The resource at the requested URL does not exist. Remediation: Use the URL of an existing resource.

Schema: Inline

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/invalidRestrictionDateRange/v1.0.0
The startOn date should be no earlier than a week before the start of the current month, and the endOn date must fall after the startOn date. Remediation: Pass valid values for startOn and endOn.
https://production.api.apiture.com/errors/restrictionDateRangeTooLarge/v1.0.0
The endOn is limited to four years after the startOn date. Remediation: Limit the endOn date to no more than four years after the startOn date.

Schema: problemResponse

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.

Wire Transfer Disclosures

getWireTransferDisclosures

Code samples

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

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

}, headers = headers)

print r.json()

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

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

Return the disclosure of the financial institution's wire transfer fees and taxes

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

Return the disclosure of the financial institution's wire transfer fees and taxes.

Example responses

200 Response

{
  "internationalRetailTransferFee": "45.00",
  "internationalRetailProcessingFee": "5.00"
}

Responses

Status	Description
200	OK
	OK.
	Schema: `wireTransferDisclosures`

Status Description

401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/unauthorized/v1.0.0
The request lacks valid authentication credentials for the target resource or operation. Remediation: Authenticate the user and pass the required authorization with the request.

Schema: Inline

Status Description

403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/forbidden/v1.0.0
The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
https://production.api.apiture.com/errors/customerDisabled/v1.0.0
The customer is disabled. Remediation: Have the customer contact the financial institution for support.
https://production.api.apiture.com/errors/antiMalwareRequired/v1.0.0
The financial institution requires the customer to have anti-malware software installed. Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
https://production.api.apiture.com/errors/modificationForbidden/v1.0.0
The customer is properly authenticated but not authorized to create, modify, or delete resources. Remediation: Avoid modification operation for customers with read-only authorization.
https://production.api.apiture.com/errors/challengeRequired/v1.0.0
The operation requires the customer to complete an identity challenge. Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call. The attributes object in the error may have the properties defined by the requiredIdentityChallenge schema.
https://production.api.apiture.com/errors/challengeBlocked/v1.0.0
The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication. Remediation: Have the user end their login session and login again.
https://production.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
This operation requires an identity challenge, but the user does not have the necessary registered authentication factors. Remediation: Have the user register one or more challenge security code delivery factors.
https://production.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
The additional on-time Challenge header in this request is expired, already used, or otherwise invalid. Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.

Schema: Inline

Status Description

429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This problem response may have one of the following type values:

https://production.api.apiture.com/errors/tooManyRequests/v1.0.0
The client has sent too many requests in a given amount of time, exceeding rate limiting. Remediation: Slow down the rate of API calls.

Schema: Inline

Status	Description
4XX	Unknown
	Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Status	Description
5XX	Unknown
	Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
	Schema: `Inline`

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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.1)	`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 problem 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

achAccountRisk

"early"

ACH Account Risk (v1.0.0)

Describes the risk level of a payment batch's settlement account.

achAccountRisk strings may have one of the following enumerated values:

Value	Description
`early`	Early: The account is debited three business days before the ACH transfer's effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with an `early` risk level.
`normal`	Normal: The account is debited two business days before the ACH transfer's effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with a `normal` risk level.
`float`	Float: The account is debited on the ACH transfer's effective date. The account balance is not checked for sufficient funds before the account is debited. A risk limit applies for commercial accounts with a `float` risk level.
`sameDay`	Same Day: The account is credited on the ACH transfer's effective day. The account balance is not checked because `sameDay` is used for credit. A risk limit and per-transaction limit applies.

type: string

enum values: early, normal, float, sameDay

address

{
  "address1": "1805 Tiburon Dr.",
  "address2": "Building 14, Suite 1500",
  "locality": "Wilmington",
  "regionCode": "NC",
  "countryCode": "US",
  "postalCode": "28403"
}

Address (v1.6.1)

A postal address that can hold a US address or an international (non-US) postal addresses.

Properties

Name	Description
`Address (v1.6.1)`	`object` A postal address that can hold a US address or an international (non-US) postal addresses.
`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}$"`
`regionName`	`string(text)` The state, district, or outlying area of the postal address. This is required if `countryCode` is not `US`. `regionCode` and `regionName` are mutually exclusive. `format: text` `minLength: 2` `maxLength: 20`
`regionCode`	`string` The state, district, or outlying area of the postal address. This is required if `countryCode` is `US`. `regionCode` and `regionName` are mutually exclusive. `minLength: 2` `maxLength: 2` `pattern: "^[A-Za-z]{2}$"`
`postalCode`	`postalCode` (required) The postal code, which varies in format by country. For postal codes in the US, this should be a five digit US ZIP code or ten character ZIP+4. `minLength: 2` `maxLength: 20` `pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"`

apiProblem

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

API Problem (v1.2.1)

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

Properties

Name	Description
`API Problem (v1.2.1)`	`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 problem 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`

atmLocationCapabilities

{
  "selfService": true
}

ATM Location Capabilities (v1.0.0)

Features and capabilities of an ATM location.

Properties

Name	Description
`ATM Location Capabilities (v1.0.0)`	`object` Features and capabilities of an ATM location.
`selfService`	`boolean` (required) If `true`, this ATM can be used to perform self-service banking functions, such as bill pay and transfers.

bankingClientConfiguration

{
  "realTimePayments": {
    "includeSender": true
  }
}

Banking Client Configuration (v1.0.0)

Properties related to banking client configuration.

Properties

Name	Description
`Banking Client Configuration (v1.0.0)`	`object` Properties related to banking client configuration.
`realTimePayments`	`realTimePaymentConfiguration` (required) Properties related to real-time payment configuration.

booleanConfiguration

{
  "enabled": true
}

Boolean Configuration (v1.0.0)

A configuration indicating whether a feature is enabled or disabled.

Properties

Name	Description
`Boolean Configuration (v1.0.0)`	`object` A configuration indicating whether a feature is enabled or disabled.
`enabled`	`boolean` (required) If `true`, the feature is enabled for the financial institution.

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`

coordinates

{
  "latitude": -90,
  "longitude": -180
}

Coordinates (v1.0.1)

The latitude and longitude coordinate positions of a location.

Properties

Name	Description
`Coordinates (v1.0.1)`	`object` The latitude and longitude coordinate positions of a location.
`latitude`	`latitude` (required) The north-south angular distance of a point on Earth's surface, as measured from the equator. Distances to the north are expressed as positive numbers. Distances to the south are expressed as negative numbers. `minimum: -90` `maximum: 90`
`longitude`	`longitude` (required) The east-west angular distance of a point on Earth's surface, as measured from the Prime Meridian (passing through Greenwich, England). Distances to the east are expressed as positive numbers. Distances to the west are expressed as negative numbers. `minimum: -180` `maximum: 180`

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

customerOrganizationDataModelType

"combined"

Customer Organization Data Model Type (v1.0.0)

Indicates the data model type used for customers and organizations.

customerOrganizationDataModelType strings may have one of the following enumerated values:

Value	Description
`combined`	Combined: The data models and APIs representing customers and organizations are combined; business banking customers are modeled as customer resources
`split`	Split: The data models and APIs representing customers and organizations are split into separate resources; businesses and organizations are not represented as customers

type: string

enum values: combined, split

cutoffTime

{
  "type": "ach",
  "time": "16:45"
}

Cutoff Time (v2.0.0)

A representation of a cutoff time for a money movement process at a financial institution.

Properties

Name Description

Cutoff Time (v2.0.0) object
A representation of a cutoff time for a money movement process at a financial institution.

type

cutoffTimeType (required)

Indicates the type of a cutoff time.

cutoffTimeType strings may have one of the following enumerated values:

Value	Description
`ach`	ACH
`sameDayAch`	Same Day ACH
`nachaPassThrough`	NACHA Pass Through
`domesticWireTransfer`	Domestic Wire Transfer
`internationalWireTransfer`	International Wire Transfer
`internationalWireTransferWithCurrencyConversion`	International Wire Transfer with Currency Conversion
`internalTransfer`	Internal Account Transfer: A transfer between accounts at the same financial institution
`externalTransfer`	External Account Transfer: A transfer to or from an account at an external financial institution
`billPay`	Bill Pay

enum values: ach, sameDayAch, nachaPassThrough, domesticWireTransfer, internationalWireTransfer, internationalWireTransferWithCurrencyConversion, internalTransfer, externalTransfer, billPay

time string (required)
The cutoff time for a product formatted in RFC 3339 time format: hh:mm. The time is expressed in 24 hour time and is set to the local time zone of the financial institution.
minLength: 5
maxLength: 5
pattern: "^([0-1][0-9]|2[0-4]):[0-5][0-9]$"

cutoffTimeType

"ach"

Cutoff Time Type (v2.0.0)

Indicates the type of a cutoff time.

cutoffTimeType strings may have one of the following enumerated values:

Value	Description
`ach`	ACH
`sameDayAch`	Same Day ACH
`nachaPassThrough`	NACHA Pass Through
`domesticWireTransfer`	Domestic Wire Transfer
`internationalWireTransfer`	International Wire Transfer
`internationalWireTransferWithCurrencyConversion`	International Wire Transfer with Currency Conversion
`internalTransfer`	Internal Account Transfer: A transfer between accounts at the same financial institution
`externalTransfer`	External Account Transfer: A transfer to or from an account at an external financial institution
`billPay`	Bill Pay

type: string

cutoffTimes

{
  "timeZoneId": "America/New_York",
  "items": [
    {
      "type": "ach",
      "time": "13:45"
    },
    {
      "type": "ach",
      "time": "16:45"
    },
    {
      "type": "sameDayAch",
      "time": "16:45"
    },
    {
      "type": "domesticWireTransfer",
      "time": "16:45"
    }
  ]
}

Cutoff Times (v2.0.0)

A representation of financial institution cutoff times for different money movement processes. A money movement process can have multiple cutoff times. The cutoff times are sorted in ascending chronological order by money movement process.

Properties

Name	Description
`Cutoff Times (v2.0.0)`	`object` A representation of financial institution cutoff times for different money movement processes. A money movement process can have multiple cutoff times. The cutoff times are sorted in ascending chronological order by money movement process.
`timeZoneId`	`timeZoneId(text)` (required) The identifier of the time zone for which all of the `items[].time` are returned in. The client can use this value to localize the `items[].time` values to the local time zone of the customer, as well as for formatting to localized names, such as `EST` and `EDT`. `format: text` `maxLength: 36`
`items`	`array: [cutoffTime]` (required) A list of cutoff times for a financial institution. `maxItems: 50` items: `object`

entityTag

"W/\"325cf1cc-e370-4baf-8faf-c6db23f195a2\""

Entity Tag (v1.0.0)

An strong or weak HTTP Entity Tag (ETag). Strong ETags take the form "{printable-non-control-ASCII-characters}" but for backwards compatibility the surrounding double quotes are optional. Weak ETags take the form W/"{printable-non-control-ASCII-characters}".

type: string

minLength: 3
maxLength: 512
pattern: "^(([\x21\x23-\x7e]{1,512})|(W\/\"[\x21\x23-\x7e]{1,509}\"))$"

identityProviderConfiguration

{
  "issuer": "http://example.com",
  "signUp_url": "http://example.com",
  "mobileApplication": {
    "clientId": "string",
    "scopes": "string",
    "profileManagement": {
      "url": "http://example.com",
      "label": "string"
    }
  },
  "webApplication": {
    "profileManagement": {
      "url": "http://example.com",
      "label": "string"
    }
  },
  "viewOnlyProperties": [
    "mobilePhone"
  ],
  "sessionExtension": {
    "strategy": "openIdConnectSessionManagement",
    "clientId": "8462dd7b-80e1",
    "scopes": "openid profile email offline"
  }
}

Identity Provider Configuration (v1.1.0)

Properties related to the identity provider configuration.

Properties

Name	Description
`Identity Provider Configuration (v1.1.0)`	`object` Properties related to the identity provider configuration.
`issuer`	`string(uri)` (required) The issuer URL for the authorization server, which serves as an identifier for the financial institution's identity provider. `format: uri` `maxLength: 500` `pattern: "^https://.*$"`
`signUp_url`	`string(uri)` If included, the URL of the financial institution's identity provider where users are sent to create a new user identity or connect their existing login. `format: uri` `maxLength: 2048`
`mobileApplication`	`identityProviderMobileApplication` Configuration properties of a mobile application for use with the financial institution's identity provider.
`webApplication`	`identityProviderWebApplication` Configuration properties of a web application for use with the financial institution's identity provider.
`viewOnlyProperties`	`array: [identityProviderViewOnlyProperty]` (required) A list of immutable identity provider profile properties. `unique items` `minItems: 0` `maxItems: 2` items: `string` » enum values: `mobilePhone`, `primaryEmail`
`sessionExtension`	`identityProviderSessionExtensionConfiguration` Configuration properties for the strategy used to extend the banking customer's session in the financial institution's identity provider. This is excluded when session extension is not configured or unavailable for this identity provider. Sessions are automatically terminated after a period of time for security reasons when not extended.

identityProviderMobileApplication

{
  "clientId": "string",
  "scopes": "string",
  "profileManagement": {
    "url": "http://example.com",
    "label": "string"
  }
}

Identity Provider Mobile Application (v1.0.1)

Configuration properties of a mobile application for use with the financial institution's identity provider.

Properties

Name	Description
`Identity Provider Mobile Application (v1.0.1)`	`object` Configuration properties of a mobile application for use with the financial institution's identity provider.
`clientId`	`string(text)` The client ID as configured in the financial institution's identity provider to be used by the banking client to authenticate and authorize a banking customer. `format: text` `maxLength: 32`
`scopes`	`string(text)` A space-delimited list of scopes the online banking application is expected to request from the identity provider. `format: text` `maxLength: 255`
`profileManagement`	`labeledUrlConfiguration` The configuration of access to the identity provider's profile management user experience.

identityProviderSessionExtensionConfiguration

{
  "strategy": "openIdConnectSessionManagement",
  "clientId": "8462dd7b-80e1",
  "scopes": "openid profile email offline"
}

Identity Provider Session Extension Configuration (v1.0.0)

Configuration properties for the strategy used to extend the banking customer's session in the financial institution's identity provider.

Properties

Name Description

Identity Provider Session Extension Configuration (v1.0.0) object
Configuration properties for the strategy used to extend the banking customer's session in the financial institution's identity provider.

strategy

identityProviderSessionStrategy (required)

The strategy used for managing an online banking session with the financial institution's identity provider.

identityProviderSessionStrategy strings may have one of the following enumerated values:

Value	Description
`legacy`	Legacy Session Management: The identity provider session is managed through a legacy strategy
`openIdConnectSessionManagement`	OpenID Connect Session Management: The identity provider session is managed through the strategy described in OpenId Connect Session Management 1.0

enum values: legacy, openIdConnectSessionManagement

clientId string(text) (required)
The identifier of the identity provider's client for using the session extension strategy.
format: text
minLength: 1
maxLength: 128

scopes string(text) (required)
The space delimited OAuth 2 scopes for clients using the session extension strategy.
format: text
minLength: 0
maxLength: 255

audience string(text)
The audience identifier for clients using the session extension strategy. The authorization server default audience is used when this value is excluded.
format: text
minLength: 1
maxLength: 255

identityProviderSessionStrategy

"legacy"

Identity Provider Session Strategy (v1.0.0)

The strategy used for managing an online banking session with the financial institution's identity provider.

identityProviderSessionStrategy strings may have one of the following enumerated values:

Value	Description
`legacy`	Legacy Session Management: The identity provider session is managed through a legacy strategy
`openIdConnectSessionManagement`	OpenID Connect Session Management: The identity provider session is managed through the strategy described in OpenId Connect Session Management 1.0

type: string

enum values: legacy, openIdConnectSessionManagement

identityProviderViewOnlyProperty

"mobilePhone"

Identity Provider View Only Property (v1.0.0)

Representation of a viewable property from the identity provider client.

identityProviderViewOnlyProperty strings may have one of the following enumerated values:

Value	Description
`mobilePhone`	Mobile Phone
`primaryEmail`	Primary Email

type: string

enum values: mobilePhone, primaryEmail

identityProviderWebApplication

{
  "profileManagement": {
    "url": "http://example.com",
    "label": "string"
  }
}

Identity Provider Web Application (v1.0.1)

Configuration properties of a web application for use with the financial institution's identity provider.

Properties

Name	Description
`Identity Provider Web Application (v1.0.1)`	`object` Configuration properties of a web application for use with the financial institution's identity provider.
`profileManagement`	`labeledUrlConfiguration` The configuration of access to the identity provider's profile management user experience.

institutionAccessLocationDayOperatingHours

{
  "open24Hours": false,
  "opens": "08:00",
  "closes": "18:00",
  "timeZoneId": "America/New_York",
  "timeZoneLabel": "EST"
}

Institution Access Location Operating Hours (v1.0.1)

The open and close times for an institution access location on a given day.

Properties

Name	Description
`Institution Access Location Operating Hours (v1.0.1)`	`object` The open and close times for an institution access location on a given day.
`open24Hours`	`boolean` (required) If `true`, the location is open 24 hours a day.
`opens`	`institutionAccessLocationOperatingTime(timeOfDay)` The time the institution access location opens. This is required when `closes` is set. This is excluded when `open24Hours` is true. `format: timeOfDay` `minLength: 5` `maxLength: 5` `pattern: "^[0-2][0-9]\\:[0-5][0-9]$"`
`closes`	`institutionAccessLocationOperatingTime(timeOfDay)` The time the institution access location closes. This is required when `opens` is set. This is excluded when `open24Hours` is true. `format: timeOfDay` `minLength: 5` `maxLength: 5` `pattern: "^[0-2][0-9]\\:[0-5][0-9]$"`
`timeZoneId`	`timeZoneId(text)` The identifier of the time zone for which the `opens` and `closes` values are returned in. This is required when `opens` and `closes` are set. The client can use this value to localize the values to the local time zone of the customer, as well as for formatting to localized names, such as `EST` and `EDT`. `format: text` `maxLength: 36`
`timeZoneLabel`	`string(text)` The localized time zone name, based on the current week and locale. This is required when `timeZoneId` is set. `format: text` `minLength: 3` `maxLength: 5`

institutionAccessLocationItem

{
  "name": "Tiburon Financial ATM",
  "type": "atm",
  "location": {
    "address": {
      "address1": "1805 Tiburon Drive",
      "locality": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28403",
      "countryCode": "US"
    },
    "coordinates": {
      "latitude": 34.20085,
      "longitude": -77.90288
    }
  },
  "distance": "6.21mi",
  "hoursOfOperation": {
    "atm": {
      "sunday": {
        "open24Hours": true
      },
      "monday": {
        "open24Hours": true
      },
      "tuesday": {
        "open24Hours": true
      },
      "wednesday": {
        "open24Hours": true
      },
      "thursday": {
        "open24Hours": true
      },
      "friday": {
        "open24Hours": true
      },
      "saturday": {
        "open24Hours": true
      }
    }
  },
  "atm": {
    "selfService": true
  }
}

Institution Access Location Item (v1.1.0)

Summary representation of an access location for a financial institution resource.

Properties

Name Description

Institution Access Location Item (v1.1.0) object
Summary representation of an access location for a financial institution resource.

name string(text) (required)
The name of this institution access location.
format: text
minLength: 3
maxLength: 150

type

institutionAccessLocationType (required)

The type of institution access location.

institutionAccessLocationType strings may have one of the following enumerated values:

Value	Description
`atm`	ATM: Automated Teller Machine
`branch`	Branch

enum values: atm, branch

location institutionAccessPhysicalLocation (required)
The physical location of a financial institution access location.

webAddress_url string(uri)
The web address of this institution access location.
format: uri
maxLength: 2048

hoursOfOperation institutionAccessLocationOperatingHoursByType
The hours of operation per access type and days.

atm atmLocationCapabilities
Capabilities and available features of an ATM location. This is required when type is atm.

distance string
Calculated distance from the origin point in the request. The unit of measure is the same as the unit in the request.
minLength: 1
maxLength: 8
pattern: "^\\d{1,3}(\\.\\d{1,2})?(mi|km)?$"

institutionAccessLocationOperatingHoursByDay

{
  "sunday": {
    "open24Hours": false,
    "opens": "08:00",
    "closes": "18:00",
    "timeZoneId": "America/New_York",
    "timeZoneLabel": "EST"
  },
  "monday": {
    "open24Hours": false,
    "opens": "08:00",
    "closes": "18:00",
    "timeZoneId": "America/New_York",
    "timeZoneLabel": "EST"
  },
  "tuesday": {
    "open24Hours": false,
    "opens": "08:00",
    "closes": "18:00",
    "timeZoneId": "America/New_York",
    "timeZoneLabel": "EST"
  },
  "wednesday": {
    "open24Hours": false,
    "opens": "08:00",
    "closes": "18:00",
    "timeZoneId": "America/New_York",
    "timeZoneLabel": "EST"
  },
  "thursday": {
    "open24Hours": false,
    "opens": "08:00",
    "closes": "18:00",
    "timeZoneId": "America/New_York",
    "timeZoneLabel": "EST"
  },
  "friday": {
    "open24Hours": false,
    "opens": "08:00",
    "closes": "18:00",
    "timeZoneId": "America/New_York",
    "timeZoneLabel": "EST"
  },
  "saturday": {
    "open24Hours": false,
    "opens": "08:00",
    "closes": "18:00",
    "timeZoneId": "America/New_York",
    "timeZoneLabel": "EST"
  }
}

Institution Access Location Operating Hours By Day (v1.0.1)

Operating hours for a location for by the day of the week. Days are excluded when the location is not open that day.

Properties

Name	Description
`Institution Access Location Operating Hours By Day (v1.0.1)`	`object` Operating hours for a location for by the day of the week. Days are excluded when the location is not open that day.
`sunday`	`institutionAccessLocationDayOperatingHours` Operating hours for this location on Sundays.
`monday`	`institutionAccessLocationDayOperatingHours` Operating hours for this location on Mondays.
`tuesday`	`institutionAccessLocationDayOperatingHours` Operating hours for this location on Tuesdays.
`wednesday`	`institutionAccessLocationDayOperatingHours` Operating hours for this location on Wednesdays.
`thursday`	`institutionAccessLocationDayOperatingHours` Operating hours for this location on Thursdays.
`friday`	`institutionAccessLocationDayOperatingHours` Operating hours for this location on Fridays.
`saturday`	`institutionAccessLocationDayOperatingHours` Operating hours for this location on Saturdays.

institutionAccessLocationOperatingHoursByType

{
  "atm": {
    "sunday": {
      "open24Hours": true
    },
    "monday": {
      "open24Hours": true
    },
    "tuesday": {
      "open24Hours": true
    },
    "wednesday": {
      "open24Hours": true
    },
    "thursday": {
      "open24Hours": true
    },
    "friday": {
      "open24Hours": true
    },
    "saturday": {
      "open24Hours": true
    }
  }
}

Institution Access Location Operating Hours by Type (v1.0.1)

Hours of operation for different access points at a location.

Properties

Name	Description
`Institution Access Location Operating Hours by Type (v1.0.1)`	`object` Hours of operation for different access points at a location.
`lobby`	`institutionAccessLocationOperatingHoursByDay` Operating hours for the lobby of a financial institution branch.
`driveThrough`	`institutionAccessLocationOperatingHoursByDay` Operating hours for a drive through. ATMs located in drive throughs use the `atm` operating hours.
`atm`	`institutionAccessLocationOperatingHoursByDay` Operating hours for an ATM. The ATM may be standalone or part of a branch.

institutionAccessLocationOperatingTime

"strin"

Institution Access Location Operating Time (v1.0.0)

A time of day expressed in RFC 3339 hh:mm 24 hour time format of the financial institution access location.

type: string(timeOfDay)

format: timeOfDay
minLength: 5
maxLength: 5
pattern: "^[0-2][0-9]\:[0-5][0-9]$"

institutionAccessLocationType

"atm"

Institution Access Location Type (v1.0.0)

The type of institution access location.

institutionAccessLocationType strings may have one of the following enumerated values:

Value	Description
`atm`	ATM: Automated Teller Machine
`branch`	Branch

type: string

enum values: atm, branch

institutionAccessLocations

{
  "start": "d1b48af913464aa49fcb07065dcc0616",
  "limit": 10,
  "nextPage_url": "https://production.api.apiture.com/banking/institutionAccessLocations/?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
  "count": 2381,
  "items": [
    {
      "name": "Tiburon Financial ATM",
      "type": "atm",
      "location": {
        "address": {
          "address1": "1805 Tiburon Drive",
          "locality": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28403",
          "countryCode": "US"
        },
        "coordinates": {
          "latitude": 34.20085,
          "longitude": -77.90288
        }
      },
      "distance": "6.21mi",
      "hoursOfOperation": {
        "atm": {
          "sunday": {
            "open24Hours": true
          },
          "monday": {
            "open24Hours": true
          },
          "tuesday": {
            "open24Hours": true
          },
          "wednesday": {
            "open24Hours": true
          },
          "thursday": {
            "open24Hours": true
          },
          "friday": {
            "open24Hours": true
          },
          "saturday": {
            "open24Hours": true
          }
        }
      },
      "atm": {
        "selfService": true
      }
    }
  ]
}

Institution Access Locations Collection (v1.2.1)

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

Properties

Name	Description
`Institution Access Locations Collection (v1.2.1)`	`object` Collection of institution access locations. The items in the collection are ordered in the `items` array. The response object may contain the `nextPage_url` pagination link.
`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 resources. If this URL is omitted, there are no more resources in the collection. `read-only` `format: uri-reference` `maxLength: 8000`
`start`	`string(text)` The opaque cursor that specifies the starting location of this page of items. `format: text` `maxLength: 256`
`items`	`array: [institutionAccessLocationItem]` (required) An array containing a page of institution access location items. `maxItems: 1000` items: `object`
`map_url`	`string(uri)` The URL of a web page that displays a map of the institution's access locations. `format: uri` `minLength: 4` `maxLength: 4000`
`count`	`integer(int32)` The total number of institution access locations which satisfy the request filters. This is optional and only included if the service can calculate it. `format: int32` `minimum: 0` `maximum: 10000`

institutionAccessPhysicalLocation

{
  "address": {
    "address1": "1805 Tiburon Drive",
    "locality": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28403",
    "countryCode": "US"
  },
  "contact": {
    "phoneNumbers": [
      {
        "type": "main",
        "number": "+19105550155"
      }
    ]
  },
  "coordinates": {
    "latitude": 34.20085,
    "longitude": -77.90288
  }
}

Institution Access Physical Location (v1.0.0)

The physical location of a financial institution access location.

Properties

Name	Description
`Institution Access Physical Location (v1.0.0)`	`object` The physical location of a financial institution access location.
`address`	`address` (required) The address of the financial institution access location.
`contact`	`institutionContact` Contact information for this institution access location.
`coordinates`	`coordinates` (required) The global positioning system (GPS) coordinates of the institution access location.

institutionConfiguration

{
  "dataSharing": {
    "enabled": false
  },
  "identityProvider": {
    "issuer": "https://liveoakbank.auth0.com",
    "webApplication": {
      "profileManagement": {
        "label": "Profile Management",
        "url": "https://liveoakbank.auth0.com/profile"
      }
    },
    "viewOnlyProperties": [
      "primaryEmail",
      "mobilePhone"
    ]
  },
  "customerOrganizationModeling": "split",
  "bankingClient": {
    "realTimePayments": {
      "includeSender": true
    }
  }
}

Institution Configuration (v2.0.0)

Representation of the institution configuration resource.

Properties

Name Description

Institution Configuration (v2.0.0) object
Representation of the institution configuration resource.

dataSharing booleanConfiguration (required)
Configuration properties related to user consented data sharing.

identityProvider identityProviderConfiguration
Configuration properties related to the financial institution's identity provider. This is excluded for financial institutions using Apiture's identity provider.

customerOrganizationModeling

customerOrganizationDataModelType (required)

Indicates the data model type used for customers and organizations.

customerOrganizationDataModelType strings may have one of the following enumerated values:

Value	Description
`combined`	Combined: The data models and APIs representing customers and organizations are combined; business banking customers are modeled as customer resources
`split`	Split: The data models and APIs representing customers and organizations are split into separate resources; businesses and organizations are not represented as customers

enum values: combined, split

bankingClient bankingClientConfiguration (required)
Properties related to banking client configuration.

institutionContact

{
  "phoneNumbers": [
    {
      "type": "business",
      "number": "+19105550155"
    }
  ],
  "emailAddress": [
    "user@example.com"
  ],
  "website": "http://example.com",
  "retailLocationName": "string"
}

Institution Contact (v1.0.0)

Contact information for this institution access location.

Properties

Name	Description
`Institution Contact (v1.0.0)`	`object` Contact information for this institution access location.
`phoneNumbers`	`array: [typedPhoneNumber]` The phone numbers for this financial institution access location. `unique items` `maxItems: 5` items: `object`
`emailAddress`	`array: [string]` The email addresses for this institution access location. `unique items` `maxItems: 5` items: `string(email)` » `format: email` » `maxLength: 80`
`website`	`string(uri)` The website for this institution access location. `format: uri` `maxLength: 255`
`retailLocationName`	`string(text)` If included, the name of the retail outlet containing this institution access location. `format: text` `minLength: 3` `maxLength: 100`

institutionId

"TIBURON"

Institution ID (v1.1.0)

The unique immutable identifier of a financial institution.

type: string

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

institutionLocatorType

"abaRoutingNumber"

Institution Locator Type (v2.0.0)

Indicates the type of the institution locator.

institutionLocatorType strings may have one of the following enumerated values:

Value	Description
`abaRoutingNumber`	ABA Routing Number: The American Bankers Association routing number of a financial institution
`swiftBicCode`	swiftBicCode: The SWIFT Business Identifier Code (BIC) code of a financial institution
`other`	Other: A financial institution identifier other than ABA Routing Number or SWIFT Business Identifier Code (BIC)

type: string

enum values: abaRoutingNumber, swiftBicCode, other

institutionLookupResult

{
  "found": true,
  "institution": {
    "name": "First Bank of Andalasia",
    "address": {
      "address1": "239 West Princess Ave.",
      "locality": "Andalasia",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28407"
    },
    "locator": "503000196",
    "locatorType": "abaRoutingNumber"
  }
}

Institution Lookup Result (v2.0.0)

Successful institution lookup result.

Properties

Name	Description
`Institution Lookup Result (v2.0.0)`	`object` Successful institution lookup result.
`found`	`boolean` (required) `true` if a financial institution was found matching the requested FI locator, `false` if none was found.
`institution`	`simpleInstitution` The name and other information about the financial institution, if found.
`intermediaryInstitutions`	`array: [simpleInstitution]` Optional intermediary institutions, if requested and if intermediary institutions are required for for international wire transfers to the beneficiary institution. This array is omitted if there none are required. `minItems: 1` `maxItems: 8` items: `object`

institutionName

"string"

Institution Name (v1.0.0)

A financial institution's name.

type: string(text)

format: text
minLength: 2
maxLength: 128

labeledUrlConfiguration

{
  "url": "http://example.com",
  "label": "string"
}

Labeled URL Configuration (v1.0.1)

A configuration for a labeled URL.

Properties

Name	Description
`Labeled URL Configuration (v1.0.1)`	`object` A configuration for a labeled URL.
`url`	`string(uri)` (required) The URL for the configuration. `format: uri` `maxLength: 2048`
`label`	`string(text)` (required) The human-readable label for the URL. `format: text` `maxLength: 200`

latitude

-90

Latitude (v1.0.0)

The north-south angular distance of a point on Earth's surface, as measured from the equator. Distances to the north are expressed as positive numbers. Distances to the south are expressed as negative numbers.

type: number

minimum: -90
maximum: 90

longitude

-180

Longitude (v1.0.1)

The east-west angular distance of a point on Earth's surface, as measured from the Prime Meridian (passing through Greenwich, England). Distances to the east are expressed as positive numbers. Distances to the west are expressed as negative numbers.

type: number

minimum: -180
maximum: 180

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

postalCode

"20521"

Postal code (v1.0.0)

The postal code, which varies in format by country. For postal codes in the US, this should be a five digit US ZIP code or ten character ZIP+4.

type: string

minLength: 2
maxLength: 20
pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"

problemResponse

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

Problem Response (v0.4.1)

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

Properties

Name	Description
`Problem Response (v0.4.1)`	`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 problem 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.

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

realTimePaymentConfiguration

{
  "includeSender": true
}

Real-Time Payment Configuration (v1.0.0)

Properties related to real-time payment configuration.

Properties

Name	Description
`Real-Time Payment Configuration (v1.0.0)`	`object` Properties related to real-time payment configuration.
`includeSender`	`boolean` (required) If true, the sender's contact information should be displayed on the user interface during the create and edit real-time payment workflows.

requiredIdentityChallenge

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

Required Challenge (v1.2.3)

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

Properties

Name	Description
`Required Challenge (v1.2.3)`	`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 401 Unauthorized problem response when the 401 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`

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

simpleInstitution

{
  "name": "First Bank of Andalasia",
  "locator": "503000196",
  "locatorType": "abaRoutingNumber",
  "address": {
    "address1": "239 West Princess Ave.",
    "locality": "Andalasia",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28407"
  }
}

Simple Institution (v2.0.0)

A simple representation of a financial institution.

Properties

Name	Description
`Simple Institution (v2.0.0)`	`object` A simple representation of a financial institution.
`name`	`institutionName(text)` (required) The financial institution's name. `format: text` `minLength: 2` `maxLength: 128`
`locator`	`string(text)` (required) The American Bankers Association routing number, SWIFT Business Identifier Code (BIC) code, or IBAN account number of the institution. The form of this institution locator string is set with the `locatorType` property. `format: text` `maxLength: 36`
`locatorType`	`institutionLocatorType` (required) Indicates the type of this institution's `locator`. enum values: `abaRoutingNumber`, `swiftBicCode`, `other`
`address`	`address` (required) The financial institution's postal mailing address.

simplePhoneNumber

"+19105550155"

Simple Phone Number (v1.1.0)

The phone number as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. If the number is masked to hide Personally Identifiable Information, all but the last four digits are replaced with one or more *, such as *1234.

type: string(phone-number)

format: phone-number
minLength: 5
maxLength: 20

timeZoneId

"America/New_York"

Time Zone Identifier or Offset (v1.3.0)

A time zone. This may be either a time zone identifier/TZ Identifier (as described by RFC 7808) in the list of time zones, or a time zone offset from UTC in the form [-+]HH:MM. Localized abbreviations, such as EST and EDT, are also allowed.

type: string(text)

format: text
maxLength: 36

transferDateRestriction

{
  "occursOn": "2022-10-10",
  "reason": "holiday",
  "debitOn": "2022-10-07"
}

Transfer Date Restriction (v1.0.0)

A date where a transfer restriction occurs, and the reason it is restricted. If the reason is holiday, closure and the transfer is an ACH transfer, the object also contains either a debitOn or creditOn date or both.

Properties

Name	Description
`Transfer Date Restriction (v1.0.0)`	`object` A date where a transfer restriction occurs, and the `reason` it is restricted. If the `reason` is `holiday`, `closure` and the transfer is an ACH transfer, the object also contains either a `debitOn` or `creditOn` date or both. `Additional Properties: false`
`occursOn`	`string(date)` (required) The date that a transfers restriction occurs, is in the ISO 8601 Date format, `yyyy-mm-dd`. `format: date` `minLength: 10` `maxLength: 10`
`reason`	`transferDateRestrictionType` (required) Indicates why this date is restricted. enum values: `pastDate`, `pastCutoffTime`, `riskRestricted`, `holiday`, `closure`, `other`
`creditOn`	`string(date)` The date the local financial institution account is credited in RFC 3339 `YYYY-MM-DD` date format. This is derived from the `date` based on the `risk` level. The credit-on date normally falls one business day after the restricted `date`. This property is only returned if the payment `type` is `achDebit` or `ach`. `format: date` `minLength: 10` `maxLength: 10`
`debitOn`	`string(date)` The date the local financial institution account is debited in RFC 3339 `YYYY-MM-DD` date format. This is derived from the `date` based on the `risk` level and the transfer direction (`achDebit` or `achCredit`). The debit-on date normally falls one to three business days before the restricted `date`. This property is only returned if the payment `type` is `achCredit` or `ach`. `format: date` `minLength: 10` `maxLength: 10`

transferDateRestrictionType

"pastDate"

Transfer Date Restriction Type (v1.0.0)

Indicates why a transfer date is restricted.

transferDateRestrictionType strings may have one of the following enumerated values:

Value	Description
`pastDate`	Past Date: The transfer date is in the past
`pastCutoffTime`	Past Cutoff Time: Transfers disallowed because the current time is past the financial institutions' cutoff time
`riskRestricted`	Risk Restricted: The date is restricted because the risk level requires one or more days for a debit to clear
`holiday`	Holiday: A Federal Reserve System observed holiday
`closure`	Closure: Financial institution closure, such as a weekend or other planned closure
`other`	Other: Other

type: string

enum values: pastDate, pastCutoffTime, riskRestricted, holiday, closure, other

transferDateRestrictions

{
  "restrictedDates": [
    {
      "occursOn": "2022-10-01",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-02",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-03",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-04",
      "reason": "pastDate"
    },
    {
      "occursOn": "2022-10-05",
      "reason": "pastCutoffTime"
    },
    {
      "occursOn": "2022-10-06",
      "reason": "riskRestricted"
    },
    {
      "occursOn": "2022-10-07",
      "reason": "riskRestricted"
    },
    {
      "occursOn": "2022-10-08",
      "reason": "closure",
      "debitOn": "2022-10-07"
    },
    {
      "occursOn": "2022-10-09",
      "reason": "closure",
      "debitOn": "2022-10-07"
    },
    {
      "occursOn": "2022-10-10",
      "reason": "holiday",
      "debitOn": "2022-10-07"
    },
    {
      "occursOn": "2022-10-15",
      "reason": "closure",
      "debitOn": "2022-10-14"
    },
    {
      "occursOn": "2022-10-16",
      "reason": "closure",
      "debitOn": "2022-10-14"
    },
    {
      "occursOn": "2022-10-22",
      "reason": "closure",
      "debitOn": "2022-10-21"
    },
    {
      "occursOn": "2022-10-23",
      "reason": "closure",
      "debitOn": "2022-10-21"
    },
    {
      "occursOn": "2022-10-29",
      "reason": "closure",
      "debitOn": "2022-10-28"
    },
    {
      "occursOn": "2022-10-30",
      "reason": "closure",
      "debitOn": "2022-10-28"
    }
  ],
  "accuracyEndsOn": "2026-12-31"
}

Transfer Date Restrictions (v1.0.0)

A list of the financial institution's transfer date restrictions. This is a list of weekdays and specific dates when the institution cannot perform the requested transfers. The response may include dates prior to requested the start date, as that is useful for populating a calendar that shows the current month and the last few days of the previous month.

Properties

Name	Description
`Transfer Date Restrictions (v1.0.0)`	`object` A list of the financial institution's transfer date restrictions. This is a list of weekdays and specific dates when the institution cannot perform the requested transfers. The response may include dates prior to requested the start date, as that is useful for populating a calendar that shows the current month and the last few days of the previous month.
`restrictedDates`	`array: [transferDateRestriction]` A list of restricted transfer dates as determined by the requested transfer parameters, holidays, and scheduled closures. This includes dates that correspond to normal day-of-week restrictions as listed in `restrictedDays`. `maxItems: 500` items: `object` » `Additional Properties: false`
`accuracyEndsOn`	`string(date)` The service only knows bank holidays for about two to four years in advance. This date is the end of that known holiday schedule, although the requested dates may extend well beyond this date. Any dates in the response beyond this date may omit holidays but may include other restricted dates based on the financial institution's normal scheduled closures such as Saturdays and Sundays. `format: date` `minLength: 10` `maxLength: 10`

transferFrequency

"once"

Transfer Frequency (v1.0.0)

For recurring transfers, the interval at which the money movement recurs.

transferFrequency strings may have one of the following enumerated values:

Value	Description
`once`	Once: Transfer does not repeat
`occasional`	Occasional: Transfer recurs but without a new scheduled date
`daily`	Daily: Repeat daily on business days
`weekly`	Weekly: Repeat weekly
`biweekly`	biweekly: Repeat every two weeks (26 times a year)
`semimonthly`	Semimonthly: Repeat twice a month (24 times a year)
`monthly`	Monthly: Repeat monthly
`monthlyFirstDay`	Monthly First Day: Repeat on the first business day of the month
`monthlyLastDay`	Monthly Last Day: Repeat on the last business day of the month
`bimonthly`	Bimonthly: Repeat every other month
`quarterly`	Quarterly: Repeat quarterly (four times a year)
`semiyearly`	Semiyearly: Repeat every six months (twice a year)
`yearly`	Yearly: Repeat once every year

type: string

enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly

transferScheduleDirection

"debit"

Transfer Schedule Direction (v1.0.0)

Provides the direction in which a transfer flows.

transferScheduleDirection strings may have one of the following enumerated values:

Value	Description
`debit`	Debit: Money is transferred from a payer to the financial institution
`credit`	Credit: Money is transferred from the financial institution to a payee
`both`	Both: Money is transferred both to and from a payee/payer

type: string

enum values: debit, credit, both

transferScheduleItem

{
  "scheduledOn": "2022-07-04",
  "effectiveOn": "2022-07-05"
}

Transfer Schedule Item (v1.0.0)

Summary representation of a transfer schedule resource in transfer schedule list.

Properties

Name	Description
`Transfer Schedule Item (v1.0.0)`	`object` Summary representation of a transfer schedule resource in transfer schedule list.
`scheduledOn`	`string(date)` (required) The scheduled date of the calculated calendar recurrence in `YYYY-MM-DD` RFC 3339 date format. `format: date` `minLength: 10` `maxLength: 10`
`effectiveOn`	`string(date)` (required) The effective date of the recurrence in `YYYY-MM-DD` RFC 3339 date format. When the effective date differs from the scheduled date, it is due to a banking holiday, weekend, or other non-business day. The date is adjusted to before the scheduled date when the transfer direction is `credit` and adjusted to after the scheduled date when the transfer direction is `debit`. `format: date` `minLength: 10` `maxLength: 10`

transferSchedules

{
  "items": [
    {
      "scheduledOn": "2022-06-27",
      "effectiveOn": "2022-06-27"
    },
    {
      "scheduledOn": "2022-07-04",
      "effectiveOn": "2022-07-05"
    },
    {
      "scheduledOn": "2022-07-11",
      "effectiveOn": "2022-07-11"
    },
    {
      "scheduledOn": "2022-07-18",
      "effectiveOn": "2022-07-18"
    },
    {
      "scheduledOn": "2022-07-25",
      "effectiveOn": "2022-07-25"
    },
    {
      "scheduledOn": "2022-08-01",
      "effectiveOn": "2022-07-01"
    }
  ]
}

Transfer Schedule List (v1.0.1)

List of transfer methods. The items in the list are ordered in the items array.

Note: The service only knows bank holidays for about two to four years in advance. Dates beyond the accuracyEndsOn date in the listTransferDateRestrictions response may not include holidays (only weekends or other institution closures.)

Properties

Name Description

Transfer Schedule List (v1.0.1)

object
List of transfer methods. The items in the list are ordered in the items array.

items array: [transferScheduleItem] (required)
An array containing upcoming transfer schedule items.
maxItems: 1000
items: object

transferTypeForDateRestrictions

"internal"

Transfer Restriction Transfer Type (v1.1.0)

Indicates the type of transfer. This determines what business rules and adjustments to make to the date restrictions.

transferTypeForDateRestrictions strings may have one of the following enumerated values:

Value	Description
`internal`	Internal: Internal account to internal account transfer
`external`	External: A transfer to or from an account at an external financial institution
`ach`	ACH: An ACH transfer that includes both debit and credit transfers
`achCredit`	ACH Credit: An ACH transfer debiting an internal account and crediting an external account
`achDebit`	ACH Debit: An ACH transfer debiting an external account and crediting an internal account
`domesticWireTransfer`	Domestic Wire Transfer
`internationalWireTransfer`	International Wire Transfer

type: string

default: "internal"
enum values: internal, external, ach, achDebit, achCredit, domesticWireTransfer, internationalWireTransfer

typedPhoneNumber

{
  "type": "business",
  "number": "+19105550155"
}

Typed Phone Number (v1.2.0)

A combination of a phone number and a method of description. This should be used when a resource is permitted to include more than one phone number.

Properties

Name	Description
`Typed Phone Number (v1.2.0)`	`object` A combination of a phone number and a method of description. This should be used when a resource is permitted to include more than one phone number.
`type`	`string(text)` (required) A typed method to differentiate the phone number. `format: text` `maxLength: 40`
`number`	`simplePhoneNumber(phone-number)` (required) The phone number as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is `+1`. Phone numbers are returned in responses in E.164 format with a leading `+`, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. If the number is masked to hide Personally Identifiable Information, all but the last four digits are replaced with one or more ``, such as `1234`. `format: phone-number` `minLength: 5` `maxLength: 20`

wireTransferDisclosures

{
  "internationalRetailTransferFee": "45.00",
  "internationalRetailProcessingFee": "5.00"
}

Wire Transfer Disclosures (v1.0.0)

Disclosed fees and taxes for wire transfers. Fees and taxes are determined by the financial institution. Omitted properties mean the tax or fee is not applicable.

Properties

Name	Description
`Wire Transfer Disclosures (v1.0.0)`	`object` Disclosed fees and taxes for wire transfers. Fees and taxes are determined by the financial institution. Omitted properties mean the tax or fee is not applicable.
`internationalRetailTransferFee`	`monetaryValue(decimal)` A fee applied to retail customers sending an international wire. `format: decimal` `maxLength: 16` `pattern: "^(0\|[1-9][0-9]*)\\.[0-9][0-9]$"`
`internationalRetailProcessingFee`	`monetaryValue(decimal)` The financial institution's processing fee for retail customers sending an international wire. `format: decimal` `maxLength: 16` `pattern: "^(0\|[1-9][0-9]*)\\.[0-9][0-9]$"`
`internationalRetailTax`	`monetaryValue(decimal)` The amount of taxes charged to a retail customer to transfer funds using an international wire. `format: decimal` `maxLength: 16` `pattern: "^(0\|[1-9][0-9]*)\\.[0-9][0-9]$"`

Generated by @apiture/api-doc 3.2.4 on Thu Feb 27 2025 22:02:32 GMT+0000 (Coordinated Universal Time).