Apiture Digital Banking v0.235.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.
APIs for digital banking client applications.
Customer Accounts
Customer-level API for listing banking accounts, balances, and other account-specific data.
Clients may use this API to:
listAccounts
- obtain a list of accounts that the authorized user has access to, returning aaccounts
collection with alist
of account objects.listEligibleAchAccounts
- obtain a list of ACH accounts that allow transfers based on SEC code and authorized account privileges.listAccountBalances
- list the balances of the customer' accounts.getAccount
- Fetch a more complete set of properties of an internal account.- Manage overdraft protection:
listEligibleOverdraftAccounts
- List accounts which may be set as overdraft protection accounts for another account.getOverdraftProtection
- fetch an account's overdraft protection settings.patchOverdraftAccounts
- update an account's overdraft protection settings.
- Manage CD renewal settings
getCdSettings
- fetch an account's CD renewal settingspatchCdSettings
- update an account's CD renewal settings
Financial Institutions
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.
Some of the operations in this API require an institutionId
path parameter. This is the unique alphanumeric code that uniquely identifies a financial institution.
Account Transactions
The Transactions API allows bank customers to list the transactions history associated with a banking account. The client may filter the transaction history by date, amount, transaction type, and other criteria. The transaction response is paginated since there may be many thousands of transactions for an account.
Transaction history items have a type
which indicates if the item is a debit
or a credit
transaction or a balance line item which establishes the account's balance Examples of debit transactions are checks drawn against an account, withdrawals, transfers from the account, fees, and adjustments. Examples of credit transactions are deposits, transfers to the account, interest, and adjustments. Check transactions include the check number.
Some transactions have associated images such as check images or deposit slips. If a transaction item has images, the hasImages
property is true
. The list transaction images operation returns those images.
Some transactions, such as ACH transfers or debit card payments, include information about the merchant, such as the merchant name, the merchant's website URL, and logo URL if available.
Transactions may also have a memo
descriptive field and a category.
Note: The financial institution may limit transaction history to the last 12 months of data.
Account to Account Transfers
Schedule and manage account to account transfers.
When creating new simple transfers, the source and target accounts, amount, and transfer schedule are required and the transfer is scheduled to be processed on the scheduled date. Some financial institutions support immediate transfers between local accounts scheduled on the current day. Transfers to or from external accounts typically are processed after the financial institution's ACH cut-off time but require several business days.
Transfers have a state
property which indicates if the transfer is pending, pending approvals, scheduled (queued for processing), processing, or processed.
Transfers support recurring schedules, such as repeating every week or every month. Recurring transfers can also be variable transfers; they recur without an amount. Occasional recurring transfers do not have a scheduled date. Both of these situations result in transfers in a pending
state. They remain pending until a patchTransfer
operation sets the amount and schedule. Once a pending
transfer has an amount and schedule, it becomes scheduled
.
Challenges
The Challenges API supports challenging banking users to verify their identity when performing other API operations.
This API supports challenges when the financial institution requires the user to prove their identity though a secondary challenge factor, such as entering a code sent to them via SMS (text message), email, voice call, or by answering security questions. User may have has one or more channels associated with each factor, such as a multiple phone numbers or e-mail addresses. The financial institution may require a challenge before certain actions that warrant extra validation, such as making transfers to an external institution, updating the customer's mailing address, or ordering replacement debit cards.
An API operation may return a 403 response with a challengeRequired
problem type name to indicate a challenge is required for that operation. (The problem response's type
is the URI https://production.api.apiture.com/errors/challengeRequired/v1.0.0/
. The actual version number v1.0.0
may change, although the problem type
URL always starts with https://production.api.apiture.com/errors/challengeRequired/
.) For challengeRequired
, the attributes
in the apiProblem
response lists the challenges that the client may choose from as described in the requiredIdentityChallenge
schema. The user must complete one of the offered challenges.
Each challenge contains a challengeFactor
which identifies how the user receives and completes the challenge. This object has a type
which describes the factor used to complete the challenge and optional string labels
which describe the channel(s) through which the user can complete the challenge. For sms
and voice
factors, the label is the last four digits of a phone number. For email
challenges, the label is a masked email address. For securityQuestions
, the challengeFactor
includes a prompt for each of the user's security questions, and does not use the labels
.
The user selects their preferred channel from those available, and the client then starts that challenge flow via the startIdentityChallenge
operation. In response to that operation, the service will send an one-time passcode of several digits to the user via the corresponding channel for the sms
, email
, voice
, authenticatorToken
challenge factors. The start operation is required to activate the challenge, even if the service does not have to send information to the user, such as with securityQuestions
.
The user enters the challenge response, such as the one-time passcode that was sent to them or the answers to their security questions, in the client. Then the client completes the challenge by verifying the user's challenge response.
The system verifies the submitted challenge response(s) and, if valid, returns a token that the client must pass via the Challenge
request header (in conjunction with the existing Authorization
header) when it retries the operation.
For example, if the user chose to complete the following sms
challenge factor:
{ "type": "sms", "id": "15488eb31d2aef258d59", "labels": [ "3774" ] }
- The client will start that challenge.
- The system sends the one-time passcode such as
987303
via SMS text message to their phone ending in 3774. - The user enters that one-time passcode
987303
in the client application. - The client application submits the one-time passcode response and the corresponding challenge
id
(15488eb31d2aef258d59
) andfactor
(sms
) andresponses
using theverifyIdentityChallenge
operation.
The verifyIdentityChallenge
response includes a result
. A result of failed
means the verification failed. A result of locked
means the user has failed too many verification attempts and the system has locked them out. The response also include an allows
object which indicate if the user can submit new response, restart the factor (i.e. resend the one-time passcode), or try the operation again to get a new challenge.
A result of verified
means the user's response matched the expected response. A response with a verified result also includes a challengeToken
value. The client must send this in the Challenge
request header in addition to the Authorization
header when retrying the operation.
For example, if the result from verifying the response contains { ... "result": "verified", "challengeToken": "91a2a7724d6e82f5cd73", ... }
and their existing bearer token is eyJraWQi...VVb1pH9bcBbg
, then the client should send the request headers:
Authentication: Bearer eyJraWQi...VVb1pH9bcBbg
Challenge: 91a2a7724d6e82f5cd73
when retrying the operation.
Download OpenAPI Definition (YAML)
Base URLs:
License: Apiture API License
Authentication
- API Key (
apiKey
)- header parameter: API-Key
- API Key based client identification. See details at Secure Access.
- OpenID Connect authentication (
accessToken
)- OpenId Connect (OIDC) authentication/authorization. The client uses the
authorization_endpoint
andtoken_endpoint
to obtain an access token to pass in theAuthorization
header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access. - OIDC Configuration URL =
https://auth.apiture.com/oidc/.well-known/openid-configuration
- OpenId Connect (OIDC) authentication/authorization. The client uses the
Accounts
Banking Accounts
listAccounts
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
List Accounts
GET https://api.apiture.com/banking/accounts
Return a paginated list of the customer's accounts, consisting of internal accounts at this financial institution and accounts at other financial institutions, if any.
Parameters
Parameter | Description |
---|---|
productType in: query | array[string] Include only accounts whose product.type is in pipe-delimited set. For example, to list only savings, checking, and CD accounts, use ?productType=savings|checking|cd .unique items minItems: 1 maxItems: 6 pipe-delimited items: string » enum values: savings , checking , cd , ira , loan , creditCard |
location in: query | string Filter accounts to just a subset of internal or external accounts (per the location property on the accountItem schema).enum values: internal , external |
allows in: query | array[string] Filter the result to accounts that have corresponding true values in account.allows . For example ?allows=transferTo,transferFrom,view returns only accounts where account.allows.transferTo , account.allows.transferFrom , and account.allows.view are all true for the caller.unique items minItems: 1 maxItems: 7 comma-delimited items: string » enum values: billPay , transferFrom , transferTo , mobileCheckDeposit , view , viewCards , manageCards |
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 .default: "" maxLength: 256 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 default: 100 minimum: 0 maximum: 1000 |
Example responses
200 Response
{
"start": "1922a8531e8384cfa71b",
"limit": 100,
"nextPage_url": "https://production.api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100?allows=view",
"count": 6,
"items": [
{
"id": "bf23bc970b78d27691e8",
"nickname": "Payroll Checking",
"label": "Payroll Checking *1008",
"product": {
"type": "checking",
"coreType": "DDA",
"code": "DDA01",
"label": "Business Checking"
},
"maskedNumber": "*1008",
"location": "internal",
"allows": {
"transferFrom": false,
"transferTo": true,
"billPay": false,
"mobileCheckDeposit": true,
"view": true,
"viewCards": true,
"manageCards": false
}
},
{
"id": "b78d27691e8bf23bc970",
"nickname": "College CD",
"label": "College CD *2017",
"product": {
"type": "cd",
"code": "CDA",
"coreType": "CD",
"label": "24 Month CD"
},
"maskedNumber": "*2017",
"location": "internal",
"allows": {
"transferFrom": false,
"transferTo": false,
"billPay": false,
"mobileCheckDeposit": false,
"view": true,
"viewCards": true,
"manageCards": false
}
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. A page from the full list of the customer's accounts. This list contains only accounts that the customer is entitled to access. While the nextPage_url property is present in the response, the client can fetch the next page of accounts by performing a GET on that URL. | |
Schema: accounts |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 422
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getAccount
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts/{accountId} HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts/{accountId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Get an Account
GET https://api.apiture.com/banking/accounts/{accountId}
Return details of the customer's internal account.
Parameters
Parameter | Description |
---|---|
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"id": "bf23bc970b78d27691e8",
"nickname": "Payroll Checking",
"label": "Payroll Checking *1008",
"maskedNumber": "*1008",
"product": {
"type": "checking",
"coreType": "DDA",
"code": "DDA01",
"label": "Business Checking"
},
"location": "internal",
"allows": {
"transferFrom": false,
"transferTo": true,
"billPay": false,
"mobileCheckDeposit": true,
"view": true,
"viewCards": true,
"manageCards": false,
"manageJointOwners": true,
"manageOverdraftAccounts": true
},
"electronicStatements": true
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The response is a representation of the customer's account. | |
Schema: account |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such banking account resource at the specified {accountId} . The response body contains details about the request error. | |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
listAccountBalances
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accountBalances \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accountBalances HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accountBalances',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accountBalances',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accountBalances',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accountBalances', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accountBalances");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accountBalances", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
List Account Balances
GET https://api.apiture.com/banking/accountBalances
Return a list of the requested internal accounts' balances. The accounts
query parameter is a list of account IDs which typically comes from the getAccounts
operation response. The returned list does not include external accounts. The caller must have entitlements to view each account's details, as indicated by a true
value for account.allows.view
. Requests to list balances for accounts the user is not allowed to read results in a 403 Forbidden response.
The response may be incomplete. Given a Retry-After
response header, the client can retry the operation after a short delay, requesting only the accounts which are incomplete; see the 202 Accepted response for details.
Parameters
Parameter | Description |
---|---|
accounts in: query | accountIds The unique account identifiers of one or more internal accounts. (Internal accounts are those with location value of internal .) If omitted, this operation uses the accounts for which the customer has view permissions but is limited to at most 1000 accounts. Note: The account IDs are unrelated to the account number.unique items minItems: 1 maxItems: 1000 comma-delimited items: string » minLength: 6 » maxLength: 48 » pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
retryCount in: query | integer(int32) When retrying the operation, pass the retryCount from the incompleteAccountBalances response.format: int32 minimum: 1 maximum: 10 |
Example responses
200 Response
{
"items": [
{
"id": "05d00d7d-d630",
"available": "3208.20",
"current": "3448.72",
"currentWithPending": "3448.72",
"updatedAt": "2022-05-02T06:51:19.375Z",
"incomplete": false
},
{
"id": "cb5d67ea-a5c3",
"available": "1750.80",
"current": "1956.19",
"currentWithPending": "1956.19",
"updatedAt": "2022-05-02T06:51:19.375Z",
"incomplete": false
}
]
}
422 Response
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/invalidAccountId/v1.0.0",
"title": "Unprocessable Entity",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No such account exists for the given account ID.",
"instance": "https://production.api.apiture.com/banking/accountBalances?accounts=bb709151-575041fcd617"
}
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/invalidAccountId/v1.0.0",
"title": "Unprocessable Entity",
"status": 422,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "No such account exists for the given account ID.",
"instance": "https://production.api.apiture.com/banking/accountBalances?accounts=bb709151-575041fcd617"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The response contains the balances for all the accounts in the ?accounts= query parameter. | |
Schema: accountBalances | |
202 | Accepted |
Accepted. The service accepted the request but could not provide balances for all the requested accounts and returned an incomplete response. Try the call again after the time in the Retry-After response header has passed, and request only those accounts which are incomplete . If there is no Retry-After response header, the client has reached its maximum number of tries and should not retry the operation. | |
Schema: incompleteAccountBalances | |
Header | Retry-After string text |
Indicates an absolute time, in HTTP Examples:
|
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
503 | Service Unavailable |
Service Unavailable. Could not fetch the account balance from the banking core. | |
Schema: problemResponse |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
listEligibleAchAccounts
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/achEligibleAccounts?allows=billPay&secCode=arc \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/achEligibleAccounts?allows=billPay&secCode=arc HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/achEligibleAccounts?allows=billPay&secCode=arc',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/achEligibleAccounts',
method: 'get',
data: '?allows=billPay&secCode=arc',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/achEligibleAccounts',
params: {
'allows' => 'array[string]',
'secCode' => '[achSecCode](#schema-achSecCode)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/achEligibleAccounts', params={
'allows': [
"billPay"
], 'secCode': 'arc'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/achEligibleAccounts?allows=billPay&secCode=arc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/achEligibleAccounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
List Eligible ACH Accounts
GET https://api.apiture.com/banking/achEligibleAccounts
Return a paginated list of a customer's accounts that are eligible for ACH transfers based on allowed privileges.
Optionally, an agent can access a business customer's ACH accounts when acting on behalf of that business customer via the optional customerId
query parameter.
Parameters
Parameter | Description |
---|---|
allows in: query | array[string] (required) Filter the result to accounts that have corresponding true values in account.allows . For example ?allows=transferTo,transferFrom,view returns only accounts where account.allows.transferTo , account.allows.transferFrom , and account.allows.view are all true for the caller.unique items minItems: 1 maxItems: 7 comma-delimited items: string » enum values: billPay , transferFrom , transferTo , mobileCheckDeposit , view , viewCards , manageCards |
secCode in: query | achSecCode (required) Filter the result to accounts that allow ACH transfers of the given Standard Entry Class (SEC) codes. enum values: arc , boc , ccd , cie , ctx , pop , ppd , rck , tel , web |
customerId in: query | resourceId The optional identifier of a business customer. This is an opaque string. An agent who is operating on behalf of a business can use this to access the resources of that business customer. The agent must have entitlements to act on behalf of the business; if not, the operation returns a 403 Forbidden response. This must match the business' customer ID (not their access ID). For other situations, omit this value. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
start in: query | string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url .default: "" maxLength: 256 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 default: 100 minimum: 0 maximum: 1000 |
Example responses
200 Response
{
"start": "1922a8531e8384cfa71b",
"limit": 100,
"nextPage_url": "https://production.api.apiture.com/banking/accounts?start=641f62296ecbf1882c84?limit=100?allows=view",
"count": 6,
"items": [
{
"id": "bf23bc970b78d27691e8",
"nickname": "Payroll Checking",
"label": "Payroll Checking *1008",
"product": {
"type": "checking",
"coreType": "DDA",
"code": "DDA01",
"label": "Business Checking"
},
"maskedNumber": "*1008",
"location": "internal",
"allows": {
"transferFrom": false,
"transferTo": true,
"billPay": false,
"mobileCheckDeposit": true,
"view": true,
"viewCards": true,
"manageCards": false
}
},
{
"id": "b78d27691e8bf23bc970",
"nickname": "College CD",
"label": "College CD *2017",
"product": {
"type": "cd",
"code": "CDA",
"coreType": "CD",
"label": "24 Month CD"
},
"maskedNumber": "*2017",
"location": "internal",
"allows": {
"transferFrom": false,
"transferTo": false,
"billPay": false,
"mobileCheckDeposit": false,
"view": true,
"viewCards": true,
"manageCards": false
}
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. A page from the full list of the customer's ACH-eligible accounts. This list contains only accounts that the customer is entitled to access. While the nextPage_url property is present in the response, the client can fetch the next page of accounts by performing a GET on that URL. | |
Schema: accounts |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 422
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Account Joint Owners
Account Joint Owners
listAccountJointOwners
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/jointOwners \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts/{accountId}/jointOwners HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/jointOwners',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/jointOwners',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/jointOwners',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/jointOwners', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/jointOwners");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/jointOwners", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of account joint owners
GET https://api.apiture.com/banking/accounts/{accountId}/jointOwners
Return a collection of account joint owners. The user must have the account.manageJointOwners
permission to use this operation.
Parameters
Parameter | Description |
---|---|
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"items": [
{
"id": "db821618461ade2c5e45",
"name": "Max Pike"
},
{
"id": "1ef8f2bdfc729ea2b80b",
"name": "Sam K. Pike"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: accountJointOwners |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
createJointOwnerInvitation
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
const fetch = require('node-fetch');
const inputBody = '{
"firstName": "Mary",
"lastName": "Jones",
"taxId": "3333",
"sharedSecret": "obsolete obese octopus",
"emailAddress": "Mary.Jones@example.com",
"birthdate": "2000-04-10"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Invite a joint owner
POST https://api.apiture.com/banking/accounts/{accountId}/jointOwnerInvitations
Create and send an invitation to another person to become a joint owner of the account. The invitation will be sent to the invitee's email address. The invitation directs the invitee to a web page to verify and accept the invitation, and if necessary, enroll in digital banking.
The authenticated user must have the account.allows.manageJointOwners
permission to use this operation.
Body parameter
{
"firstName": "Mary",
"lastName": "Jones",
"taxId": "3333",
"sharedSecret": "obsolete obese octopus",
"emailAddress": "Mary.Jones@example.com",
"birthdate": "2000-04-10"
}
Parameters
Parameter | Description |
---|---|
body | newJointOwnerInvitation (required) Data necessary to invite a joint owner. |
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"id": "db4f580290d3e07bf55d",
"firstName": "Mary",
"lastName": "Jones",
"taxId": "3333",
"sharedSecret": "obsolete obese octopus",
"emailAddress": "Mary.Jones@example.com",
"birthdate": "2000-04-10"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: jointOwnerInvitation | |
Header | Location string uri-reference |
The URI of the new invitation resource. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such banking account resource at the specified {accountId} . The response body contains details about the request error. | |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 422
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Overdraft Protection
Overdraft Protection Settings
listEligibleOverdraftAccounts
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
List Eligible Overdraft Accounts
GET https://api.apiture.com/banking/accounts/{accountId}/eligibleOverdraftAccounts
Return a paginated list of a customer's accounts that are eligible to serve as overdraft protection accounts for the given account. An overdraft protection account is a deposit account that the financial institution can transfer funds from to prevent the account balance from going negative and incurring non-sufficient funds fees.
The user must have the allows.manageOverdraftAccounts
permission on the account to use this operation.
To obtain available balances for these accounts, use listAccountBalances
.
Parameters
Parameter | Description |
---|---|
start in: query | string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url .default: "" maxLength: 256 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 default: 100 minimum: 0 maximum: 1000 |
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"start": "1922a8531e8384cfa71b",
"limit": 100,
"nextPage_url": "https://production.api.apiture.com/banking/accounts/f204d292df9fb/eligibleOverdraftAccounts?start=641f62296ecbf1882c84?limit=100",
"items": [
{
"id": "da1331a9e9168ea91346",
"label": "Checking *3456",
"maskedNumber": "*3456"
},
{
"id": "5c9b4e50a0401ef4eb2e",
"label": "Premiere Savings *1234",
"maskedNumber": "*1234"
}
],
"maximumOverdraftAccounts": 1
}
Responses
Status | Description |
---|---|
200 | OK |
OK. A page from the full list of the customer's eligible overdraft accounts. This list contains only accounts that the customer is entitled to access. While the nextPage_url property is present in the response, the client can fetch the next page of accounts by performing a GET on that URL. | |
Schema: eligibleOverdraftAccounts |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such banking account resource at the specified {accountId} . The response body contains details about the request error. | |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Status Code 422
Property Name | Description |
---|---|
Problem Response (v0.4.1) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getOverdraftProtection
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of the account's overdraft protection settings
GET https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection
Return the JSON representation of this account's overdraft protection settings.
Parameters
Parameter | Description |
---|---|
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"maximumOverdraftAccounts": 1,
"accounts": [
{
"id": "da1331a9e9168ea91346",
"label": "Checking *3456",
"maskedNumber": "*3456"
},
{
"id": "5c9b4e50a0401ef4eb2e",
"label": "Premiere Savings *1234",
"maskedNumber": "*1234"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: overdraftProtection |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Unprocessable Entity. There is no such banking account resource at the specified account This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
patchOverdraftAccounts
Code samples
# You can also use wget
curl -X PATCH https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PATCH https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
const fetch = require('node-fetch');
const inputBody = '{
"items": [
{
"id": "da1331a9e9168ea91346",
"label": "Checking *3456",
"maskedNumber": "*3456"
},
{
"id": "5c9b4e50a0401ef4eb2e",
"label": "Premiere Savings *1234",
"maskedNumber": "*1234"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.patch 'https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.patch('https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update the overdraft accounts
PATCH https://api.apiture.com/banking/accounts/{accountId}/overdraftProtection
Perform a partial update of the overdraft accounts. Only fields in the request body are updated on the resource; fields which are omitted are not updated. To add, replace, or remove an overdraft account, add, replace, or remove the corresponding account item from the items
array. Only the account id
in the items is significant.
The user must have the allows.manageOverdraftAccounts
permission on the account to use this operation.
Body parameter
{
"items": [
{
"id": "da1331a9e9168ea91346",
"label": "Checking *3456",
"maskedNumber": "*3456"
},
{
"id": "5c9b4e50a0401ef4eb2e",
"label": "Premiere Savings *1234",
"maskedNumber": "*1234"
}
]
}
Parameters
Parameter | Description |
---|---|
body | overdraftProtectionPatch (required) The replacement overdraft accounts. |
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"maximumOverdraftAccounts": 1,
"accounts": [
{
"id": "da1331a9e9168ea91346",
"label": "Checking *3456",
"maskedNumber": "*3456"
},
{
"id": "5c9b4e50a0401ef4eb2e",
"label": "Premiere Savings *1234",
"maskedNumber": "*1234"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: overdraftProtection |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such banking account resource at the specified {accountId} . The response body contains details about the request error. | |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. There is no such banking account resource at the specified account This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Account CD Settings
Account CD Renewal Settings
getCdSettings
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/cdSettings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts/{accountId}/cdSettings HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/cdSettings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/cdSettings',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/cdSettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/cdSettings', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/cdSettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/cdSettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return an account's CD settings
GET https://api.apiture.com/banking/accounts/{accountId}/cdSettings
Return an account's CD settings. This operation is only available if the account's type
is cd
and the caller has the allows.view
permission for the account.
Parameters
Parameter | Description |
---|---|
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"maturesAt": "2023-10-30T08:00:00.000Z",
"term": "P6M",
"maturityPolicy": "transferPrincipalAndInterest",
"transferAccount": {
"id": "e821ce54-c715",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
},
"inDebitGracePeriod": true,
"inCreditGracePeriod": true,
"debitGracePeriodEndsAt": "2023-11-10T08:00:00.000Z",
"creditGracePeriodEndsAt": "2023-11-10T08:00:00.000Z"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: cdAccountSettings |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
patchCdSettings
Code samples
# You can also use wget
curl -X PATCH https://api.apiture.com/banking/accounts/{accountId}/cdSettings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
PATCH https://api.apiture.com/banking/accounts/{accountId}/cdSettings HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
const fetch = require('node-fetch');
const inputBody = '{
"maturityPolicy": "transferPrincipalAndInterest",
"transferAccount": {
"id": "e821ce54-c715",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/cdSettings',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/cdSettings',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.patch 'https://api.apiture.com/banking/accounts/{accountId}/cdSettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.patch('https://api.apiture.com/banking/accounts/{accountId}/cdSettings', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/cdSettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.apiture.com/banking/accounts/{accountId}/cdSettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update an account's CD settings
PATCH https://api.apiture.com/banking/accounts/{accountId}/cdSettings
Update an account's CD settings. This operation is only available if the account's type
is cd
and the caller has the allows.edit
permission for the account.
Body parameter
{
"maturityPolicy": "transferPrincipalAndInterest",
"transferAccount": {
"id": "e821ce54-c715",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
}
}
Parameters
Parameter | Description |
---|---|
body | cdAccountSettingsPatch (required) Mutable CD settings. |
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"maturesAt": "2023-10-30T08:00:00.000Z",
"term": "P6M",
"maturityPolicy": "transferPrincipalAndInterest",
"transferAccount": {
"id": "e821ce54-c715",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
},
"inDebitGracePeriod": true,
"inCreditGracePeriod": true,
"debitGracePeriodEndsAt": "2023-11-10T08:00:00.000Z",
"creditGracePeriodEndsAt": "2023-11-10T08:00:00.000Z"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: cdAccountSettings |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request was well-formed but the data cannot be processed. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Institutions
Banking Institutions
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 , ibanAccountNumber |
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 |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Schedules
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 default: 6 minimum: 1 maximum: 12 |
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 |
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 error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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: string' \
-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: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/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':'string',
'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' => 'string',
'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': 'string',
'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{"string"},
"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. maxLength: 36 pattern: ^([a-zA-Z0-9_]+\/[a-zA-Z0-9_]+(?:\/[a-zA-Z0-9_]+)*|[-+][012][0-9]:[0-6][0-9])$ |
If-None-Match in: header | string 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.maxLength: 512 pattern: ^\P{Cc}{1,512}$ |
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 error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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 error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not found. There is no such resource at the request URL. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Transactions
Banking Account Transactions
listTransactions
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/transactions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts/{accountId}/transactions HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/transactions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/transactions',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/transactions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/transactions', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/transactions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/transactions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of transactions
GET https://api.apiture.com/banking/accounts/{accountId}/transactions
Return a paginated collection of transaction history for this internal account.
Note: this operation may return a 202 Accepted and a Retry-After
response header if the server requires more time to build the list of transactions. The client should retry after that delay, as described in the 202 response below.
With the Accept: text/csv
request header (instead of Accept: application/json
), this operation returns a comma-separated values (CSV) text response instead of a JSON response.
The first row in the file is the CSV column headers, corresponding to the properties in the transactionItem
:
Date,Type,Subtype,Check Number,Description,Amount,Balance,Posted,Memo,Category ID,Category Label,Merchant Name,Id
If a value does not exist for a record in the CSV, the corresponding column in the CSV is blank. All records have all 13 columns. For example, if the transaction has no memo, merchant, category, or check number, the row may look like
2023-04-07,credit,other,,counter deposit,120.75,2034.70,true,,,,,HR49D9289498DHJE
The CSV file contains up to limit
number of transactions. If there is another page of transactions, the Link response header provides a link for fetching the next page of CSV transactions. The link URL includes a new ?start=
value. The link parameter "rel"
has the value "next"
to indicate this is the link to the next page. For example:
Link: <https://production.api.apiture.com/banking/accounts/581ca61abab3/transactions?start=88a9e9a3cd13f742?limit=1000>; rel="next"
For Accept: application/json
, the nextPage_url
link in the response, if present, is a pagination link to the next page of transactions for the given filters.
This operation returns a 403 Forbidden error if the customer does not have view
permissions in the account.allows
object, or a 422 Unprocessable Entity if called on an external account.
The default response lists only recent transactions. Normally, this is transactions for the most recent 30 days, although for high-volume accounts, it may be a shorter period.
Parameters
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 .default: "" maxLength: 256 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 default: 100 minimum: 0 maximum: 10000 |
occurredOn in: query | string Return only transactions whose occurredOn date is in this date range. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. Each account has an implicit default transaction history range of n days. This is normally 30 days but may be shorter for accounts with high activity. This n day period is applied to any unbounded date ranges. The default date range is the most recent n days. Example date ranges:
minLength: 10 maxLength: 24 pattern: ^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$ |
posted in: query | boolean Limit transactions in the response based on the transaction's posted value. If true , include only posted transactions. If false , include only non-posted transactions. If omitted, do not filter based on posted . Note that using this filter excludes balance items because the posted property is not set on balance items, so neither true or false match them. |
category in: query | array[string] Filter transactions to only those whose category is in this pipe-separated list. Categories are set by a transaction cleansing service or assigned by the account holder. Categories can include names such as "Shopping" , "Deposit" , "Bill" , "Transfer" , or "Other" .unique items minItems: 1 maxItems: 16 pipe-delimited items: string(text) » format: text » minLength: 1 » maxLength: 64 |
type in: query | array[string] Filter transactions to only those whose type is in this pipe-separated list.unique items minItems: 1 maxItems: 3 pipe-delimited items: string » enum values: balance , debit , credit |
subtype in: query | array[string] Filter transactions to only those whose subtype is in this pipe-separated list.unique items minItems: 1 maxItems: 2 pipe-delimited items: string » enum values: check , other |
amount in: query | amountRange Return only transactions whose amount is in this numeric range. This compares only the absolute value of the transaction. That is, the value [1000.00,1100.00) matches either a debit of -1070.25 or a credit of 1021.90 .Some examples of specifying an amount range:
minLength: 1 maxLength: 30 pattern: ^((\d+(\.\d{0,2})?)|([\[\(](((\d+(\.\d{0,2})?),((\d+(\.\d{0,2})?))?)|(,(\d+(\.\d{0,2})?)))[\]\)]))$ |
checkNumber in: query | checkNumberRange Return only transactions whose check.number is in this integer range. Examples:
maxLength: 20 pattern: ^\d+|([[(](\d+,(\d+)?|,\d+)[)\]])$ |
retryCount in: query | integer(int32) When retrying the operation, pass the retryCount from the incompleteTransactions response.format: int32 minimum: 1 maximum: 10 |
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"start": "d1b48af913464aa49fcb07065dcc0616",
"limit": 10,
"nextPage_url": "https://production.api.apiture.com/banking/accounts/c9fc25b47d52916fc9ad/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
"count": 2381,
"items": [
{
"id": "d62c0701-0d74",
"type": "balance",
"subtype": "other",
"occurredOn": "2023-06-18",
"amount": "0.00",
"posted": true,
"balance": "8509.38"
},
{
"id": "88f5bf17-ecc4",
"type": "debit",
"subtype": "check",
"occurredOn": "2023-06-18",
"memo": "Paid electric bill",
"merchant": {
"name": "B&T's Excellent Electric Co.",
"website_url": "https://BillTedsExcellentElectricCompany.example.com/",
"logo_url": "https://BillTedsExcellentElectricCompany.example.com/img/logos/medium.png"
},
"amount": "1276.21",
"posted": true,
"balance": "8509.38",
"category": {
"label": "Utilities",
"id": "127"
},
"check": {
"number": 8412,
"imageFront_url": "/accounts/1d16e438-18e0/transactions/88f5bf17-ecc4/images/front/content",
"imageBack_url": "/accounts/1d16e438-18e0/transactions/88f5bf17-ecc4/images/back/content"
}
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The response is either the JSON transactions representation if the request included Accept: application/json or comma-separated values text if using Accept: text/csv . | |
Schema: string | |
202 | Accepted |
Accepted. The service accepted the request but could not list the transactions for the date range in a reasonable amount of time. The system continues fetching the transactions so that they are available after one or more retries. Try the call again after the time in the Retry-After response header has passed. When retrying a request for a JSON response, pass the value of the When trying a request for a CSV response, the returned
If there is no | |
Schema: string | |
Header | Retry-After string text |
Indicates an absolute time, in HTTP Examples:
|
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such banking account resource at the specified {accountId} or the customer does not have entitlement to that account. | |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
504 | Gateway Time-out |
Gateway Timeout. The server did not receive a timely response from an upstream server it needed to access in order to complete the request. This error response may have one of the following
| |
Schema: problemResponse |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Transaction Categories
Banking Account Transaction Categories
listTransactionCategories
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/transactionCategories \
-H 'Accept: application/json' \
-H 'If-None-Match: string' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/transactionCategories HTTP/1.1
Host: api.apiture.com
Accept: application/json
If-None-Match: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/transactionCategories',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'If-None-Match':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/transactionCategories',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'If-None-Match' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/transactionCategories',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'If-None-Match': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/transactionCategories', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/transactionCategories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"If-None-Match": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/transactionCategories", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of transaction categories
GET https://api.apiture.com/banking/transactionCategories
Return a collection of transaction categories. The response is limited to 1,000 categories.
This is a conditional operation when the If-None-Match
header is used. If the client has a transactionCategories
response and the ETag
returned from a previous call, this operation returns a 304 Not Modified if called again when the categories collection has not changed.
Parameters
Parameter | Description |
---|---|
If-None-Match in: header | string 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.maxLength: 512 pattern: ^\P{Cc}{1,512}$ |
Example responses
200 Response
{
"items": [
{
"id": "ef7958260dce34abddb7",
"label": "Groceries",
"type": "debit"
},
{
"id": "f24096860ebf1383e202",
"label": "Dining",
"type": "debit"
},
{
"id": "33c3d38ca0a744b8d903",
"label": "Entertainment",
"type": "debit"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: transactionCategories | |
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 error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Transaction Images
Images Associated With a Transaction
listTransactionImages
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images HTTP/1.1
Host: api.apiture.com
Accept: application/json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a page of images associated with a transaction
GET https://api.apiture.com/banking/accounts/{accountId}/transactions/{transactionId}/images
Return the JSON representation of the images associated with this transaction.
Images include check images and deposit slips. This operation only applies to transaction items where hasImages
is true
. Page sizes are determined by the number of images and how many can be encoded in the API response. Use the nextPage_url
from the response, if any, to fetch the next page of images.
Parameters
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 .default: "" maxLength: 256 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 default: 100 minimum: 0 maximum: 1000 |
accountId in: path | resourceId (required) The unique identifier of this account resource. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
transactionId in: path | transactionId (required) The unique identifier of this transaction resource. This is an opaque string. read-only minLength: 6 maxLength: 256 pattern: ^[-_:,.~$a-zA-Z0-9]{6,256}$ |
Example responses
200 Response
{
"start": "1922a8531e8384cfa71b",
"limit": 16,
"nextPage_url": "/banking/transactions/91fd4ce044a22130f986/images?start=6",
"count": 16,
"images": [
{
"contentType": "image/png",
"content": "SW1hZ2luZSB0aGlzIGFzIGEgUE5HIGNoZWNrIGltYWdlLCBub3QgdGV4dC4=",
"side": "front"
},
{
"contentType": "image/png",
"content": "SW1hZ2luZSB0aGlzIGFzIGFub3RoZXIgUE5HIGNoZWNrIGltYWdlLCBub3QgdGV4dC4=",
"side": "back"
},
{
"unavailable": true
},
{
"unavailable": true
},
{
"contentType": "image/jpeg",
"content": "SW1hZ2luZSB0aGlzIGFzIGEgSlBFRyBjaGVjayBpbWFnZS4=",
"side": "front"
},
{
"contentType": "image/jpeg",
"content": "SW1hZ2luZSB0aGlzIGFzIHlldCBhbm90aGVyIEpQRUcgY2hlY2sgaW1hZ2Uu",
"side": "back"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: transactionImages |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Transfers
Banking Transfers
listTransfers
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/transfers \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/transfers 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/transfers',
{
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/transfers',
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/transfers',
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/transfers', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/transfers");
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/transfers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of transfers
GET https://api.apiture.com/banking/transfers
Return a paginated collection of transfers. The nextPage_url in the response is a pagination link.
Parameters
Parameter | Description |
---|---|
scheduledOn in: query | dateRange Return only transactions whose schedule.scheduledOn date is in this date range. Excludes any transfers that do not have a scheduledOn date. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. Example date ranges:
maxLength: 24 pattern: ^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$ |
debitsOn in: query | dateRange Return only transactions whose schedule.debitsOn date (when the funds are debited from the source account) is in this date range. Excludes any transfers that do not have a scheduledOn date. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. See the scheduledOn query parameter for examples.maxLength: 24 pattern: ^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$ |
creditsOn in: query | dateRange Return only transactions whose schedule.creditsOn (when the funds are credited to the target account) is in this date range. Excludes any transfers that do not have a scheduledOn date. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. See the scheduledOn query parameter for examples.maxLength: 24 pattern: ^\d{4}-\d{2}-\d{2}|([[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$ |
historical in: query | boolean If true , list only historical (state is processed ) transfers. If false , list only transfers that have not yet finished processing. If omitted, list all transfers. |
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 .default: "" maxLength: 256 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 default: 100 minimum: 0 maximum: 1000 |
Example responses
200 Response
{
"start": "d1b48af913464aa49fcb07065dcc0616",
"limit": 10,
"nextPage_url": "https://production.api.apiture.com/transfers/transfers?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10",
"items": [
{
"id": "0399abed-fd3d",
"amount": "275.00",
"memo": "Cover check for car repair",
"state": "processed",
"sourceAccount": {
"id": "bd9b7af2-6f9b",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
},
"targetAccount": {
"id": "88b1ca3e-d0f3",
"label": "Personal Savings *4567",
"type": "savings",
"location": "internal"
},
"schedule": {
"scheduledOn": "2026-06-28",
"frequency": "once",
"creditsOn": "2026-06-26",
"debitsOn": "2026-06-24"
},
"processedAt": "2022-06-28T21:00:00.000Z"
},
{
"id": "d62c0701-0d74",
"amount": "100.00",
"state": "scheduled",
"memo": "school expenses",
"sourceAccount": {
"id": "bd9b7af2-6f9b",
"label": "Checking *6789",
"type": "checking",
"location": "internal"
},
"targetAccount": {
"id": "c8396f59-624b",
"label": "Checking *3456",
"type": "checking",
"location": "internal"
},
"schedule": {
"scheduledOn": "2023-08-01",
"frequency": "monthly",
"recurrenceType": "fixed",
"count": 9,
"creditsOn": "2023-08-01",
"debitsOn": "2026-08-01"
}
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: transfers |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
createTransfer
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/banking/transfers \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Challenge: string' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/banking/transfers HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
Challenge: string
const fetch = require('node-fetch');
const inputBody = '{
"amount": "275.00",
"memo": "Cover check for car repair",
"sourceAccount": {
"id": "bd9b7af2-6f9b",
"location": "internal"
},
"targetAccount": {
"id": "88b1ca3e-d0f3",
"location": "internal"
},
"schedule": {
"scheduledOn": "2022-06-28",
"frequency": "once"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Challenge':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/transfers',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Challenge':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/transfers',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Challenge' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/banking/transfers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Challenge': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/banking/transfers', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/transfers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Challenge": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/banking/transfers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new transfer
POST https://api.apiture.com/banking/transfers
Create a new transfer within the transfers collection. If all the necessary properties are set, the transfer is queued for processing. If the request omits the schedule.scheduledOn
date, the transfer remains pending/unscheduled until the user sets it via the patchTransfer
operation.
Note: This operation requires an identity challenge if the financial institution requires the user to prove their identity for some types of transfers. See the "Challenges API". See the various error types in the 403 response.
Body parameter
{
"amount": "275.00",
"memo": "Cover check for car repair",
"sourceAccount": {
"id": "bd9b7af2-6f9b",
"location": "internal"
},
"targetAccount": {
"id": "88b1ca3e-d0f3",
"location": "internal"
},
"schedule": {
"scheduledOn": "2022-06-28",
"frequency": "once"
}
}
Parameters
Parameter | Description |
---|---|
Challenge in: header | challengeToken This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type.minLength: 6 maxLength: 255 pattern: ^[-_:.~%$a-zA-Z0-9]{6,255}$ |
body | newTransfer (required) The data necessary to create a new transfer. |
Example responses
201 Response
{
"id": "0399abed-fd3d",
"state": "scheduled",
"amount": "275.00",
"sourceAccount": {
"id": "bd9b7af2-6f9b",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
},
"targetAccount": {
"id": "88b1ca3e-d0f3",
"label": "Personal Savings *4567",
"type": "savings",
"location": "internal"
},
"schedule": {
"scheduledOn": "2026-06-28",
"frequency": "once",
"creditsOn": "2026-06-26",
"debitsOn": "2026-06-24"
},
"processedAt": "2026-06-26T21:00:00.000Z",
"updatedBy": "James Bond",
"memo": "Cover check for car repair"
}
Responses
Status | Description |
---|---|
201 | Created |
Created. | |
Schema: transfer | |
Header | Location string uri-reference |
The URI of the new transfer. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The user's permissions do not allow the transfer. Either the user does not have This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
getTransfer
Code samples
# You can also use wget
curl -X GET https://api.apiture.com/banking/transfers/{transferId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
GET https://api.apiture.com/banking/transfers/{transferId} 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/transfers/{transferId}',
{
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/transfers/{transferId}',
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/transfers/{transferId}',
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/transfers/{transferId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/transfers/{transferId}");
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/transfers/{transferId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this transfer
GET https://api.apiture.com/banking/transfers/{transferId}
Return the JSON representation of this transfer resource.
Parameters
Parameter | Description |
---|---|
transferId in: path | resourceId (required) The unique identifier of this transfer. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"id": "0399abed-fd3d",
"state": "scheduled",
"amount": "275.00",
"sourceAccount": {
"id": "bd9b7af2-6f9b",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
},
"targetAccount": {
"id": "88b1ca3e-d0f3",
"label": "Personal Savings *4567",
"type": "savings",
"location": "internal"
},
"schedule": {
"scheduledOn": "2026-06-28",
"frequency": "once",
"creditsOn": "2026-06-26",
"debitsOn": "2026-06-24"
},
"processedAt": "2026-06-26T21:00:00.000Z",
"updatedBy": "James Bond",
"memo": "Cover check for car repair"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: transfer |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such transfer resource at the specified {transferId} . | |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
patchTransfer
Code samples
# You can also use wget
curl -X PATCH https://api.apiture.com/banking/transfers/{transferId} \
-H 'Content-Type: application/merge-patch+json' \
-H 'Accept: application/json' \
-H 'Challenge: string' \
-H 'Authorization: Bearer {access-token}'
PATCH https://api.apiture.com/banking/transfers/{transferId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json
Challenge: string
const fetch = require('node-fetch');
const inputBody = '{
"amount": "275.00",
"targetAccount": {
"id": "88b1ca3e-d0f3"
},
"schedule": {
"scheduledOn": "2022-06-28",
"frequency": "once"
}
}';
const headers = {
'Content-Type':'application/merge-patch+json',
'Accept':'application/json',
'Challenge':'string',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/transfers/{transferId}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/merge-patch+json',
'Accept':'application/json',
'Challenge':'string',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/transfers/{transferId}',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/merge-patch+json',
'Accept' => 'application/json',
'Challenge' => 'string',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.patch 'https://api.apiture.com/banking/transfers/{transferId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/merge-patch+json',
'Accept': 'application/json',
'Challenge': 'string',
'Authorization': 'Bearer {access-token}'
}
r = requests.patch('https://api.apiture.com/banking/transfers/{transferId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/transfers/{transferId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/merge-patch+json"},
"Accept": []string{"application/json"},
"Challenge": []string{"string"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PATCH", "https://api.apiture.com/banking/transfers/{transferId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this transfer
PATCH https://api.apiture.com/banking/transfers/{transferId}
Perform a partial update of this transfer as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated.
Note: This operation requires an identity challenge if the financial institution requires the user to prove their identity for some types of transfers. See the "Challenges API". See the various error types in the 403 response.
Body parameter
{
"amount": "275.00",
"targetAccount": {
"id": "88b1ca3e-d0f3"
},
"schedule": {
"scheduledOn": "2022-06-28",
"frequency": "once"
}
}
Parameters
Parameter | Description |
---|---|
Challenge in: header | challengeToken This operation may require a completed challenge. If the first attempt calling this operation fails with a 403 challengeRequired error, the client should complete the challenge flow as described in the Challenges API, then retry the operation with this Challenge request header using the challengeToken returned at the end of that flow. If this is passed but the value is invalid, the operation fails with a 403 status code and the invalidIdentityChallengeHeader problem type.minLength: 6 maxLength: 255 pattern: ^[-_:.~%$a-zA-Z0-9]{6,255}$ |
body | transferPatch (required) The fields to update within the transfer. |
transferId in: path | resourceId (required) The unique identifier of this transfer. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
200 Response
{
"id": "0399abed-fd3d",
"state": "scheduled",
"amount": "275.00",
"sourceAccount": {
"id": "bd9b7af2-6f9b",
"label": "Premiere Checking *6789",
"type": "checking",
"location": "internal"
},
"targetAccount": {
"id": "88b1ca3e-d0f3",
"label": "Personal Savings *4567",
"type": "savings",
"location": "internal"
},
"schedule": {
"scheduledOn": "2026-06-28",
"frequency": "once",
"creditsOn": "2026-06-26",
"debitsOn": "2026-06-24"
},
"processedAt": "2026-06-26T21:00:00.000Z",
"updatedBy": "James Bond",
"memo": "Cover check for car repair"
}
Responses
Status | Description |
---|---|
200 | OK |
OK. | |
Schema: transfer |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The user's permissions do not allow the transfer. Either the user does not have This error response may have one of the following
| |
Schema: problemResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such transfer resource at the specified {transferId} . | |
Schema: problemResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
deleteTransfer
Code samples
# You can also use wget
curl -X DELETE https://api.apiture.com/banking/transfers/{transferId} \
-H 'Accept: application/problem+json' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.apiture.com/banking/transfers/{transferId} HTTP/1.1
Host: api.apiture.com
Accept: application/problem+json
const fetch = require('node-fetch');
const headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/transfers/{transferId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Accept':'application/problem+json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/transfers/{transferId}',
method: 'delete',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/problem+json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.apiture.com/banking/transfers/{transferId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/problem+json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.apiture.com/banking/transfers/{transferId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/transfers/{transferId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/problem+json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "https://api.apiture.com/banking/transfers/{transferId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this transfer resource
DELETE https://api.apiture.com/banking/transfers/{transferId}
Delete this transfer resource and any resources that are owned by it. Only transfers that have not been processed may be deleted.
Parameters
Parameter | Description |
---|---|
transferId in: path | resourceId (required) The unique identifier of this transfer. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
Example responses
401 Response
{
"id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
"type": "https://production.api.apiture.com/errors/unauthorized/v1.0.0",
"title": "Unauthorized",
"status": 401,
"occurredAt": "2022-04-25T12:42:21.375Z",
"detail": "The request lacks valid authentication credentials",
"instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}
Responses
Status | Description |
---|---|
204 | No Content |
No Content. The operation succeeded but returned no response body. |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such transfer resource at the specified {transferId} . | |
Schema: problemResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. |
Challenges
Challenges
startIdentityChallenge
Code samples
# You can also use wget
curl -X POST https://api.apiture.com/banking/startedChallenges \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
POST https://api.apiture.com/banking/startedChallenges HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
const fetch = require('node-fetch');
const inputBody = '{
"operationId": "createTransfer",
"challengeId": "b8cae0901002bba4e2a7",
"factor": "sms",
"factorId": "mobile-1"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.apiture.com/banking/startedChallenges',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
var headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.apiture.com/banking/startedChallenges',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.apiture.com/banking/startedChallenges',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.apiture.com/banking/startedChallenges', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.apiture.com/banking/startedChallenges");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "https://api.apiture.com/banking/startedChallenges", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Start an identity challenge
POST https://api.apiture.com/banking/startedChallenges
Start the identity challenge flow for the user's chosen factor. For sms
, voice
, and email
challenges, this causes the system to send a four to six digit code to the user via SMS, automated voice phone call, or email. The factor passed in the request is marked as active and eligible to be verified. The user should complete the challenge by submitting their response(s) to the challenge via the verifyIdentityChallenge
operation.
Body parameter
{
"operationId": "createTransfer",
"challengeId": "b8cae0901002bba4e2a7",
"factor": "sms",
"factorId": "mobile-1"
}
Parameters
Parameter | Description |
---|---|
body | identityChallenge (required) The data necessary to initiate an identity challenge flow. |
Example responses
200 Response
{
"operationId": "createTransfer",
"challengeId": "b8cae0901002bba4e2a7",
"factor": "sms",
"factorId": "mobile-1",
"expiresAt": "2023-01-05T08:50:33.375Z",
"minimumResponseLength": 8,
"maximumResponseLength": 8
}
Responses
Status | Description |
---|---|
200 | OK |
OK. The identity challenge flow was started successfully. | |
Schema: startedIdentityChallenge |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body, request headers, and/or query parameters are not well-formed. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
401 | Unauthorized |
Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
403 | Forbidden |
Forbidden. The authenticated caller is not authorized to perform the requested operation. This error response may have one of the following
| |
Schema: Inline |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. This error response may have one of the following
| |
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 error response may have one of the following
| |
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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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 | 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 | The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599 |
» detail | A human-readable explanation specific to this occurrence of the problem. maxLength: 256 |
» instance | 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 | The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$ |
» occurredAt | 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: Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 |
» attributes | 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) | API problem or error response, as per RFC 9457 application/problem+json. |
» type | 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" . |