diff --git a/packages/cli/openapi-ir-sdk/fern/definition/example.yml b/packages/cli/openapi-ir-sdk/fern/definition/example.yml index 3f06fe55d22..46516549cbc 100644 --- a/packages/cli/openapi-ir-sdk/fern/definition/example.yml +++ b/packages/cli/openapi-ir-sdk/fern/definition/example.yml @@ -22,9 +22,10 @@ types: float: double double: double string: string - datetime: datetime - date: date - base64: base64 + # typed as string to handle invalid datetime strings + datetime: string + date: string + base64: string boolean: boolean LiteralExample: diff --git a/packages/cli/openapi-ir-sdk/src/sdk/api/resources/example/types/PrimitiveExample.ts b/packages/cli/openapi-ir-sdk/src/sdk/api/resources/example/types/PrimitiveExample.ts index c772cbbcf6c..75c5f1e3335 100644 --- a/packages/cli/openapi-ir-sdk/src/sdk/api/resources/example/types/PrimitiveExample.ts +++ b/packages/cli/openapi-ir-sdk/src/sdk/api/resources/example/types/PrimitiveExample.ts @@ -43,7 +43,7 @@ export declare namespace PrimitiveExample { interface Datetime extends _Utils { type: "datetime"; - value: Date; + value: string; } interface Date_ extends _Utils { @@ -71,7 +71,7 @@ export declare namespace PrimitiveExample { float: (value: number) => _Result; double: (value: number) => _Result; string: (value: string) => _Result; - datetime: (value: Date) => _Result; + datetime: (value: string) => _Result; date: (value: string) => _Result; base64: (value: string) => _Result; boolean: (value: boolean) => _Result; @@ -145,7 +145,7 @@ export const PrimitiveExample = { }; }, - datetime: (value: Date): FernOpenapiIr.PrimitiveExample.Datetime => { + datetime: (value: string): FernOpenapiIr.PrimitiveExample.Datetime => { return { value: value, type: "datetime", diff --git a/packages/cli/openapi-ir-sdk/src/sdk/serialization/resources/example/types/PrimitiveExample.ts b/packages/cli/openapi-ir-sdk/src/sdk/serialization/resources/example/types/PrimitiveExample.ts index d97669e7d4c..ca53c173820 100644 --- a/packages/cli/openapi-ir-sdk/src/sdk/serialization/resources/example/types/PrimitiveExample.ts +++ b/packages/cli/openapi-ir-sdk/src/sdk/serialization/resources/example/types/PrimitiveExample.ts @@ -27,7 +27,7 @@ export const PrimitiveExample: core.serialization.Schema< value: core.serialization.string(), }), datetime: core.serialization.object({ - value: core.serialization.date(), + value: core.serialization.string(), }), date: core.serialization.object({ value: core.serialization.string(), diff --git a/packages/cli/openapi-ir-to-fern/src/buildEndpointExample.ts b/packages/cli/openapi-ir-to-fern/src/buildEndpointExample.ts index 6c4255c55d2..8d8c0796cd1 100644 --- a/packages/cli/openapi-ir-to-fern/src/buildEndpointExample.ts +++ b/packages/cli/openapi-ir-to-fern/src/buildEndpointExample.ts @@ -169,7 +169,7 @@ function convertPrimitive(primitiveExample: PrimitiveExample): RawSchemas.Exampl case "datetime": try { // remove milliseconds from the datetime - return primitiveExample.value.toISOString().replace(/\.\d{3}Z$/, "Z"); + return new Date(primitiveExample.value).toISOString().replace(/\.\d{3}Z$/, "Z"); } catch (e) { return "2024-01-15T09:30:00Z"; } diff --git a/packages/cli/openapi-ir-to-fern/src/buildWebsocketSessionExample.ts b/packages/cli/openapi-ir-to-fern/src/buildWebsocketSessionExample.ts index b12f34d79a9..1cedda1e22a 100644 --- a/packages/cli/openapi-ir-to-fern/src/buildWebsocketSessionExample.ts +++ b/packages/cli/openapi-ir-to-fern/src/buildWebsocketSessionExample.ts @@ -142,7 +142,7 @@ function convertPrimitive(primitiveExample: PrimitiveExample): RawSchemas.Exampl case "datetime": try { // remove milliseconds from the datetime - return primitiveExample.value.toISOString().replace(/\.\d{3}Z$/, "Z"); + return new Date(primitiveExample.value).toISOString().replace(/\.\d{3}Z$/, "Z"); } catch (e) { return "2024-01-15T09:30:00Z"; } diff --git a/packages/cli/openapi-parser/src/__test__/__snapshots__/apiture.test.ts.snap b/packages/cli/openapi-parser/src/__test__/__snapshots__/apiture.test.ts.snap index 515e087927a..a3f5bff3fca 100644 --- a/packages/cli/openapi-parser/src/__test__/__snapshots__/apiture.test.ts.snap +++ b/packages/cli/openapi-parser/src/__test__/__snapshots__/apiture.test.ts.snap @@ -1,3 +1,12719 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`open api parser apiture parse open api 1`] = `Promise {}`; +exports[`open api parser apiture parse open api 1`] = ` +{ + "channel": [], + "description": "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\`](#op-listAccounts) - obtain a list of accounts that the authorized user has access to, + returning a [\`accounts\`](#schema-accounts) collection with a \`list\` of account objects. + * [\`listEligibleAchAccounts\`](#op-listEligibleAchAccounts) - obtain a list of ACH accounts that allow + transfers based on SEC code and authorized account privileges. + * [\`listAccountBalances\`](#op-listAccountBalances) - list the balances of the customer' accounts. + * [\`getAccount\`](#op-getAccount) - Fetch a more complete set of properties of an internal account. + * Manage overdraft protection: + * [\`listEligibleOverdraftAccounts\`](#op-listEligibleOverdraftAccounts) - List accounts which may be set as + overdraft protection accounts for another account. + * [\`getOverdraftProtection\`](#op-getOverdraftProtection) - fetch an account's overdraft protection settings. + * [\`patchOverdraftAccounts\`](#op-patchOverdraftAccounts) - update an account's overdraft protection settings. + +## Financial Institutions + +Operations related to bank and credit union financial institutions (FIs). This API provides the following features + + 1. [Calculating upcoming dates](#op-listTransferSchedule) for transfer schedules, factoring in weekends, non-business days, and + banking holidays as determined by the institution, + 1. Provide a [list of transfer date restrictions](#op-getTransferDateRestrictions): + dates when users should not schedule transfers, based on transfer parameters, + 1. [Look up a financial institution](#op-lookUpInstitutionByLocator) by an FI locator value: either an ABA routing and transit number, + an IBAN account number, or a SWIFT/BIC code, + 1. [Fetching Cutoff times for FI money movement requests](#op-getCutoffTimes). + +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 view 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. + +Transactions have a \`type\` which indicates if the item is a balance transaction which establishes the account's balance, or a \`debit\`, or a \`credit\` transaction. 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 and links to the check front and back 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 also have a \`memo\` descriptive field which the customer can change. Each non-balance transaction can also be assigned to a _category_. The customer can edit their list of custom transaction categories. There is also a pre-defined list of fixed categories. (_Category management is to be designed._) + +**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\`](#schema-transferState) 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\`](#op-patchTransfer) operation sets the amount and schedule. Once a \`pending\` transfer has an amount and schedule, it becomes \`scheduled\`.", + "endpoints": [ + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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.", + "errorStatusCode": [ + 400, + 401, + 403, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "count": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + "items": { + "type": "array", + "value": [ + { + "properties": { + "allows": { + "properties": { + "billPay": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "manageCards": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "mobileCheckDeposit": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "transferFrom": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "transferTo": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "view": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "viewCards": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + }, + "type": "object", + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "id", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *1008", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "maskedNumber": { + "type": "primitive", + "value": { + "type": "string", + "value": "maskedNumber", + }, + }, + "nickname": { + "type": "primitive", + "value": { + "type": "string", + "value": "Payroll Checking", + }, + }, + "product": { + "properties": { + "code": { + "type": "primitive", + "value": { + "type": "string", + "value": "180D_CDA", + }, + }, + "description": { + "type": "primitive", + "value": { + "type": "string", + "value": "Certificate of Deposit with a 180 day term", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "180 Day CD", + }, + }, + "type": { + "type": "enum", + "value": "cd", + }, + }, + "type": "object", + }, + }, + "type": "object", + }, + ], + }, + "limit": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + "nextPage_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://production.api.apiture.com/banking/accounts/bf23bc970b78d27691e8", + }, + }, + "primaryAccountId": { + "type": "primitive", + "value": { + "type": "string", + "value": "primaryAccountId", + }, + }, + "start": { + "type": "primitive", + "value": { + "type": "string", + "value": "start", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "AccountsListAccountsRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/accounts", + "pathParameters": [], + "queryParameters": [ + { + "description": "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\`.", + "name": "productType", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountsRequestProductType", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListAccountsRequestProductType", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "AccountsListAccountsRequestProductTypeItem", + "groupName": null, + "nameOverride": null, + "schema": "productType", + "type": "reference", + }, + }, + }, + }, + { + "description": "Filter accounts to just a subset of \`internal\` or \`external\` accounts (per the \`location\` property on the [\`accountItem\`](#schema-accountItem) schema).", + "name": "location", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountsRequestLocation", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListAccountsRequestLocation", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "internal", + "nameOverride": null, + "value": "internal", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "external", + "nameOverride": null, + "value": "external", + }, + ], + }, + }, + }, + { + "description": "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.", + "name": "allows", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountsRequestAllows", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListAccountsRequestAllows", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "AccountsListAccountsRequestAllowsItem", + "groupName": null, + "nameOverride": null, + "schema": "accountAllowsFilter", + "type": "reference", + }, + }, + }, + }, + { + "description": "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\`.", + "name": "start", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountsRequestStart", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListAccountsRequestStart", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "The maximum number of items to return in this paged response.", + "name": "limit", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountsRequestLimit", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListAccountsRequestLimit", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "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.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountsResponse", + "groupName": null, + "nameOverride": null, + "schema": "accounts", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "accounts", + ], + "methodName": "listAccounts", + }, + "server": [], + "summary": "List Accounts", + "tags": [ + "Accounts", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Return details of the customer's internal account.", + "errorStatusCode": [ + 401, + 403, + 404, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "accountId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "accountId", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "allows": { + "properties": { + "billPay": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "manageCards": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "manageJointOwners": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "manageOverdraftAccounts": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "mobileCheckDeposit": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "transferFrom": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "transferTo": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "view": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "viewCards": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + }, + "type": "object", + }, + "electronicStatements": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "id", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *1008", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "maskedNumber": { + "type": "primitive", + "value": { + "type": "string", + "value": "maskedNumber", + }, + }, + "nickname": { + "type": "primitive", + "value": { + "type": "string", + "value": "Payroll Checking", + }, + }, + "product": { + "properties": { + "code": { + "type": "primitive", + "value": { + "type": "string", + "value": "180D_CDA", + }, + }, + "description": { + "type": "primitive", + "value": { + "type": "string", + "value": "Certificate of Deposit with a 180 day term", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "180 Day CD", + }, + }, + "type": { + "type": "enum", + "value": "cd", + }, + }, + "type": "object", + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "AccountsGetAccountRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/accounts/{accountId}", + "pathParameters": [ + { + "description": "The unique identifier of this account resource. This is an opaque string.", + "name": "accountId", + "schema": { + "description": null, + "generatedName": "AccountsGetAccountRequestAccountId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK. The response is a representation of the customer's account.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "AccountsGetAccountResponse", + "groupName": null, + "nameOverride": null, + "schema": "account", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "accounts", + ], + "methodName": "getAccount", + }, + "server": [], + "summary": "Get an Account", + "tags": [ + "Accounts", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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.", + "errorStatusCode": [ + 401, + 403, + 422, + 429, + 503, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "items": { + "type": "array", + "value": [ + { + "properties": { + "available": { + "type": "primitive", + "value": { + "type": "string", + "value": "3208.20", + }, + }, + "current": { + "type": "primitive", + "value": { + "type": "string", + "value": "3448.72", + }, + }, + "currentWithPending": { + "type": "primitive", + "value": { + "type": "string", + "value": "3448.72", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "05d00d7d-d630", + }, + }, + "incomplete": { + "type": "primitive", + "value": { + "type": "boolean", + "value": false, + }, + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-05-02T06:51:19.375Z", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "available": { + "type": "primitive", + "value": { + "type": "string", + "value": "1750.80", + }, + }, + "current": { + "type": "primitive", + "value": { + "type": "string", + "value": "1956.19", + }, + }, + "currentWithPending": { + "type": "primitive", + "value": { + "type": "string", + "value": "1956.19", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "cb5d67ea-a5c3", + }, + }, + "incomplete": { + "type": "primitive", + "value": { + "type": "boolean", + "value": false, + }, + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-05-02T06:51:19.375Z", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "available": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "current": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "currentWithPending": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "id", + }, + }, + "incomplete": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2021-10-30T19:06:04.250Z", + }, + }, + }, + "type": "object", + }, + ], + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "AccountsListAccountBalancesRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/accountBalances", + "pathParameters": [], + "queryParameters": [ + { + "description": "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.", + "name": "accounts", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountBalancesRequestAccounts", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListAccountBalancesRequestAccounts", + "groupName": null, + "nameOverride": null, + "schema": "accountIds", + "type": "reference", + }, + }, + }, + { + "description": "When retrying the operation, pass the \`retryCount\` from the \`incompleteAccountBalances\` response.", + "name": "retryCount", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountBalancesRequestRetryCount", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListAccountBalancesRequestRetryCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK. The response contains the balances for all the accounts in the \`?accounts=\` query parameter.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "AccountsListAccountBalancesResponse", + "groupName": null, + "nameOverride": null, + "schema": "accountBalances", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "accounts", + ], + "methodName": "listAccountBalances", + }, + "server": [], + "summary": "List Account Balances", + "tags": [ + "Accounts", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Return a collection of account joint owners. The user must have the \`account.manageJointOwners\` permission to use this operation.", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "accountId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "accountId", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "items": { + "type": "array", + "value": [ + { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "0399abed-fd3d", + }, + }, + "name": { + "type": "primitive", + "value": { + "type": "string", + "value": "Max Pike", + }, + }, + }, + "type": "object", + }, + ], + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "AccountJointOwnersListAccountJointOwnersRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/accounts/{accountId}/jointOwners", + "pathParameters": [ + { + "description": "The unique identifier of this account resource. This is an opaque string.", + "name": "accountId", + "schema": { + "description": null, + "generatedName": "AccountJointOwnersListAccountJointOwnersRequestAccountId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "AccountJointOwnersListAccountJointOwnersResponse", + "groupName": null, + "nameOverride": null, + "schema": "accountJointOwners", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "accountJointOwners", + ], + "methodName": "listAccountJointOwners", + }, + "server": [], + "summary": "Return a collection of account joint owners", + "tags": [ + "Account Joint Owners", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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.", + "errorStatusCode": [ + 400, + 401, + 403, + 422, + ], + "examples": [], + "generatedRequestName": "AccountsListEligibleAchAccountsRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/achEligibleAccounts", + "pathParameters": [], + "queryParameters": [ + { + "description": "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.", + "name": "allows", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestAllows", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestAllowsItem", + "groupName": null, + "nameOverride": null, + "schema": "accountAllowsFilter", + "type": "reference", + }, + }, + }, + { + "description": "Filter the result to accounts that allow ACH transfers of the given Standard Entry Class (SEC) codes.", + "name": "secCode", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestSecCode", + "groupName": null, + "nameOverride": null, + "schema": "achSecCode", + "type": "reference", + }, + }, + { + "description": "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. For other situations, omit this value, else this _must_ match the authenticated caller's customer ID (not their access ID).", + "name": "customerId", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestCustomerId", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestCustomerId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + }, + }, + { + "description": "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\`.", + "name": "start", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestStart", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestStart", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "The maximum number of items to return in this paged response.", + "name": "limit", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestLimit", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsRequestLimit", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "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.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "AccountsListEligibleAchAccountsResponse", + "groupName": null, + "nameOverride": null, + "schema": "accounts", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "accounts", + ], + "methodName": "listEligibleAchAccounts", + }, + "server": [], + "summary": "List Eligible ACH Accounts", + "tags": [ + "Accounts", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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\`](#op-listAccountBalances).", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "accountId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "accountId", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "items": { + "type": "unknown", + "value": { + "type": "map", + "value": [ + { + "key": { + "type": "string", + "value": "0", + }, + "value": { + "type": "map", + "value": [ + { + "key": { + "type": "string", + "value": "id", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "da1331a9e9168ea91346", + }, + }, + }, + { + "key": { + "type": "string", + "value": "label", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *3456", + }, + }, + }, + { + "key": { + "type": "string", + "value": "maskedNumber", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "*3456", + }, + }, + }, + ], + }, + }, + { + "key": { + "type": "string", + "value": "1", + }, + "value": { + "type": "map", + "value": [ + { + "key": { + "type": "string", + "value": "id", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "5c9b4e50a0401ef4eb2e", + }, + }, + }, + { + "key": { + "type": "string", + "value": "label", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "Premiere Savings *1234", + }, + }, + }, + { + "key": { + "type": "string", + "value": "maskedNumber", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "*1234", + }, + }, + }, + ], + }, + }, + ], + }, + }, + "limit": { + "type": "primitive", + "value": { + "type": "int", + "value": 100, + }, + }, + "maximumOverdraftAccounts": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + "nextPage_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://production.api.apiture.com/banking/accounts/f204d292df9fb/eligibleOverdraftAccounts?start=641f62296ecbf1882c84?limit=100", + }, + }, + "start": { + "type": "primitive", + "value": { + "type": "string", + "value": "start", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "OverdraftProtectionListEligibleOverdraftAccountsRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/accounts/{accountId}/eligibleOverdraftAccounts", + "pathParameters": [ + { + "description": "The unique identifier of this account resource. This is an opaque string.", + "name": "accountId", + "schema": { + "description": null, + "generatedName": "OverdraftProtectionListEligibleOverdraftAccountsRequestAccountId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [ + { + "description": "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\`.", + "name": "start", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "OverdraftProtectionListEligibleOverdraftAccountsRequestStart", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "OverdraftProtectionListEligibleOverdraftAccountsRequestStart", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "The maximum number of items to return in this paged response.", + "name": "limit", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "OverdraftProtectionListEligibleOverdraftAccountsRequestLimit", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "OverdraftProtectionListEligibleOverdraftAccountsRequestLimit", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "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.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "OverdraftProtectionListEligibleOverdraftAccountsResponse", + "groupName": null, + "nameOverride": null, + "schema": "eligibleOverdraftAccounts", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "overdraftProtection", + ], + "methodName": "listEligibleOverdraftAccounts", + }, + "server": [], + "summary": "List Eligible Overdraft Accounts", + "tags": [ + "Overdraft Protection", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Return the JSON representation of this account's overdraft protection settings.", + "errorStatusCode": [ + 401, + 403, + 404, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "accountId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "accountId", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "accounts": { + "type": "map", + "value": [ + { + "key": { + "type": "string", + "value": "key", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "value", + }, + }, + }, + ], + }, + "maximumOverdraftAccounts": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "OverdraftProtectionGetOverdraftProtectionRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/accounts/{accountId}/overdraftProtection", + "pathParameters": [ + { + "description": "The unique identifier of this account resource. This is an opaque string.", + "name": "accountId", + "schema": { + "description": null, + "generatedName": "OverdraftProtectionGetOverdraftProtectionRequestAccountId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "OverdraftProtectionGetOverdraftProtectionResponse", + "groupName": null, + "nameOverride": null, + "schema": "overdraftProtection", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "overdraftProtection", + ], + "methodName": "getOverdraftProtection", + }, + "server": [], + "summary": "Fetch a representation of the account's overdraft protection settings", + "tags": [ + "Overdraft Protection", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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.", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "accountId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "accountId", + }, + }, + }, + ], + "queryParameters": [], + "request": { + "properties": {}, + "type": "object", + }, + "response": { + "properties": { + "accounts": { + "type": "map", + "value": [ + { + "key": { + "type": "string", + "value": "key", + }, + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "value", + }, + }, + }, + ], + }, + "maximumOverdraftAccounts": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "OverdraftProtectionPatchOverdraftAccountsRequest", + "headers": [], + "internal": null, + "method": "PATCH", + "operationId": null, + "path": "/accounts/{accountId}/overdraftProtection", + "pathParameters": [ + { + "description": "The unique identifier of this account resource. This is an opaque string.", + "name": "accountId", + "schema": { + "description": null, + "generatedName": "OverdraftProtectionPatchOverdraftAccountsRequestAccountId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": { + "contentType": null, + "description": null, + "schema": { + "description": null, + "generatedName": "OverdraftProtectionPatchOverdraftAccountsRequest", + "groupName": null, + "nameOverride": null, + "schema": "overdraftProtectionPatch", + "type": "reference", + }, + "type": "json", + }, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "OverdraftProtectionPatchOverdraftAccountsResponse", + "groupName": null, + "nameOverride": null, + "schema": "overdraftProtection", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "overdraftProtection", + ], + "methodName": "patchOverdraftAccounts", + }, + "server": [], + "summary": "Update the overdraft accounts", + "tags": [ + "Overdraft Protection", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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.", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "accountId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "accountId", + }, + }, + }, + ], + "queryParameters": [], + "request": { + "properties": { + "disallowDebitCardAccess": { + "type": "primitive", + "value": { + "type": "boolean", + "value": false, + }, + }, + "emailAddress": { + "type": "primitive", + "value": { + "type": "string", + "value": "Mary.Jones@example.com", + }, + }, + "firstName": { + "type": "primitive", + "value": { + "type": "string", + "value": "Mary", + }, + }, + "lastName": { + "type": "primitive", + "value": { + "type": "string", + "value": "Jones", + }, + }, + "sharedSecret": { + "type": "primitive", + "value": { + "type": "string", + "value": "obsolete obese octopus", + }, + }, + }, + "type": "object", + }, + "response": { + "properties": { + "disallowDebitCardAccess": { + "type": "primitive", + "value": { + "type": "boolean", + "value": false, + }, + }, + "emailAddress": { + "type": "primitive", + "value": { + "type": "string", + "value": "Mary.Jones@example.com", + }, + }, + "firstName": { + "type": "primitive", + "value": { + "type": "string", + "value": "Mary", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "db4f580290d3e07bf55d", + }, + }, + "lastName": { + "type": "primitive", + "value": { + "type": "string", + "value": "Jones", + }, + }, + "sharedSecret": { + "type": "primitive", + "value": { + "type": "string", + "value": "obsolete obese octopus", + }, + }, + "taxId": { + "type": "primitive", + "value": { + "type": "string", + "value": "taxId", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "JointOwnersCreateJointOwnerInvitationRequest", + "headers": [], + "internal": null, + "method": "POST", + "operationId": null, + "path": "/accounts/{accountId}/jointOwnerInvitations", + "pathParameters": [ + { + "description": "The unique identifier of this account resource. This is an opaque string.", + "name": "accountId", + "schema": { + "description": null, + "generatedName": "JointOwnersCreateJointOwnerInvitationRequestAccountId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": { + "contentType": null, + "description": null, + "schema": { + "description": null, + "generatedName": "JointOwnersCreateJointOwnerInvitationRequest", + "groupName": null, + "nameOverride": null, + "schema": "newJointOwnerInvitation", + "type": "reference", + }, + "type": "json", + }, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "JointOwnersCreateJointOwnerInvitationResponse", + "groupName": null, + "nameOverride": null, + "schema": "jointOwnerInvitation", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "jointOwners", + ], + "methodName": "createJointOwnerInvitation", + }, + "server": [], + "summary": "Invite a joint owner", + "tags": [ + "Account Joint Owners", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Look up a financial institution by their country code and either [American Bankers Association routing number](https://www.aba.com/about-us/routing-number), by [International Bank Account Number (IBAN)](https://www.ecbs.org/iban.htm), or by [SWIFT Business Identifier Code (BIC) code](https://www.swift.com/standards/data-standards/bic-business-identifier-code). Optionally, include a list of intermediary institutions that may be necessary to complete international wire transfers.", + "errorStatusCode": [ + 400, + 401, + 403, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [], + "queryParameters": [ + { + "name": "locator", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "locator", + }, + }, + }, + { + "name": "locatorType", + "value": { + "type": "enum", + "value": "abaRoutingNumber", + }, + }, + { + "name": "countryCode", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "countryCode", + }, + }, + }, + ], + "request": null, + "response": { + "properties": { + "found": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "institution": { + "properties": { + "address": { + "properties": { + "address1": { + "type": "primitive", + "value": { + "type": "string", + "value": "239 West Princess Ave.", + }, + }, + "address2": { + "type": "primitive", + "value": { + "type": "string", + "value": "Building 14, Suite 1500", + }, + }, + "countryCode": { + "type": "primitive", + "value": { + "type": "string", + "value": "US", + }, + }, + "locality": { + "type": "primitive", + "value": { + "type": "string", + "value": "Andalasia", + }, + }, + "postalCode": { + "type": "primitive", + "value": { + "type": "string", + "value": "28407", + }, + }, + "regionCode": { + "type": "primitive", + "value": { + "type": "string", + "value": "NC", + }, + }, + "regionName": { + "type": "primitive", + "value": { + "type": "string", + "value": "regionName", + }, + }, + }, + "type": "object", + }, + "locator": { + "type": "primitive", + "value": { + "type": "string", + "value": "503000196", + }, + }, + "locatorType": { + "type": "enum", + "value": "abaRoutingNumber", + }, + "name": { + "type": "primitive", + "value": { + "type": "string", + "value": "First Bank of Andalasia", + }, + }, + }, + "type": "object", + }, + "intermediaryInstitutions": { + "type": "array", + "value": [ + { + "properties": { + "address": { + "properties": { + "address1": { + "type": "primitive", + "value": { + "type": "string", + "value": "239 West Princess Ave.", + }, + }, + "address2": { + "type": "primitive", + "value": { + "type": "string", + "value": "Building 14, Suite 1500", + }, + }, + "countryCode": { + "type": "primitive", + "value": { + "type": "string", + "value": "US", + }, + }, + "locality": { + "type": "primitive", + "value": { + "type": "string", + "value": "Andalasia", + }, + }, + "postalCode": { + "type": "primitive", + "value": { + "type": "string", + "value": "28407", + }, + }, + "regionCode": { + "type": "primitive", + "value": { + "type": "string", + "value": "NC", + }, + }, + }, + "type": "object", + }, + "locator": { + "type": "primitive", + "value": { + "type": "string", + "value": "503000196", + }, + }, + "locatorType": { + "type": "enum", + "value": "abaRoutingNumber", + }, + "name": { + "type": "primitive", + "value": { + "type": "string", + "value": "First Bank of Andalasia", + }, + }, + }, + "type": "object", + }, + ], + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "InstitutionsLookUpInstitutionByLocatorRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/institutionByLocator", + "pathParameters": [], + "queryParameters": [ + { + "description": "The financial institution lookup key (routing number, IBAN, or SWIFT/BIC), as indicated by the \`locatorType\` query parameter.", + "name": "locator", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsLookUpInstitutionByLocatorRequestLocator", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 36, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "description": "Indicates what type of value the \`locator\` query parameter is.", + "name": "locatorType", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsLookUpInstitutionByLocatorRequestLocatorType", + "groupName": null, + "nameOverride": null, + "schema": "institutionLocatorType", + "type": "reference", + }, + }, + { + "description": "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\`.", + "name": "countryCode", + "parameterNameOverride": null, + "schema": { + "description": "The [ISO-3611 alpha-2](https://www.iso.org/glossary-for-iso-3166.html) value for the country associated with the financial institution.", + "generatedName": "InstitutionsLookUpInstitutionByLocatorRequestCountryCode", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 2, + "minLength": 2, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "description": "If looking up a beneficiary institution for a wire transfer beneficiary institution, request the response also include a list of intermediary institutions.", + "name": "includeIntermediaryInstitutions", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsLookUpInstitutionByLocatorRequestIncludeIntermediaryInstitutions", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsLookUpInstitutionByLocatorRequestIncludeIntermediaryInstitutions", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "InstitutionsLookUpInstitutionByLocatorResponse", + "groupName": null, + "nameOverride": null, + "schema": "institutionLookupResult", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "institutions", + ], + "methodName": "lookUpInstitutionByLocator", + }, + "server": [], + "summary": "Look up institution by routing number, IBAN, or SWIFT/BIC code", + "tags": [ + "Institutions", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Return a transfer schedule list for this institution.", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "institutionId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "TIBURON", + }, + }, + }, + ], + "queryParameters": [ + { + "name": "startsOn", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-04", + }, + }, + }, + { + "name": "endsOn", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-04", + }, + }, + }, + { + "name": "direction", + "value": { + "type": "enum", + "value": "debit", + }, + }, + { + "name": "frequency", + "value": { + "type": "enum", + "value": "once", + }, + }, + ], + "request": null, + "response": { + "properties": { + "items": { + "type": "array", + "value": [ + { + "properties": { + "effectiveOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-06-27", + }, + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-06-27", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "effectiveOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-04", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "effectiveOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-11", + }, + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-11", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "effectiveOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-18", + }, + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-18", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "effectiveOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-25", + }, + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-25", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "effectiveOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-01", + }, + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-08-01", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "effectiveOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-04", + }, + }, + }, + "type": "object", + }, + ], + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "InstitutionsListTransferScheduleRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/institutions/{institutionId}/transferSchedule", + "pathParameters": [ + { + "description": "The unique identifier of a financial institution.", + "name": "institutionId", + "schema": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestInstitutionId", + "groupName": null, + "nameOverride": null, + "schema": "institutionId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [ + { + "description": "The date to use to begin calculations of the transfer schedule in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format.", + "name": "startsOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestStartsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "description": "The date to use to conclude calculations of the transfer schedule in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format.", + "name": "endsOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestEndsOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestEndsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "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.", + "name": "direction", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestDirection", + "groupName": null, + "nameOverride": null, + "schema": "transferScheduleDirection", + "type": "reference", + }, + }, + { + "description": "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.", + "name": "count", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestCount", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + { + "description": "The interval at which the money movement recurs.", + "name": "frequency", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleRequestFrequency", + "groupName": null, + "nameOverride": null, + "schema": "transferFrequency", + "type": "reference", + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "InstitutionsListTransferScheduleResponse", + "groupName": null, + "nameOverride": null, + "schema": "transferSchedules", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "institutions", + ], + "methodName": "listTransferSchedule", + }, + "server": [], + "summary": "Return this institution's list of upcoming transfer schedule dates", + "tags": [ + "Schedules", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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](#schema-cutoffTimeType) 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.", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 412, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "institutionId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "TIBURON", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "items": { + "type": "array", + "value": [ + { + "properties": { + "time": { + "type": "primitive", + "value": { + "type": "string", + "value": "13:45", + }, + }, + "type": { + "type": "enum", + "value": "ach", + }, + }, + "type": "object", + }, + { + "properties": { + "time": { + "type": "primitive", + "value": { + "type": "string", + "value": "16:45", + }, + }, + "type": { + "type": "enum", + "value": "ach", + }, + }, + "type": "object", + }, + { + "properties": { + "time": { + "type": "primitive", + "value": { + "type": "string", + "value": "16:45", + }, + }, + "type": { + "type": "enum", + "value": "sameDayAch", + }, + }, + "type": "object", + }, + { + "properties": { + "time": { + "type": "primitive", + "value": { + "type": "string", + "value": "16:45", + }, + }, + "type": { + "type": "enum", + "value": "domesticWireTransfer", + }, + }, + "type": "object", + }, + { + "properties": { + "time": { + "type": "primitive", + "value": { + "type": "string", + "value": "16:45", + }, + }, + "type": { + "type": "enum", + "value": "ach", + }, + }, + "type": "object", + }, + ], + }, + "timeZoneId": { + "type": "primitive", + "value": { + "type": "string", + "value": "America/New_York", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "InstitutionsGetCutoffTimesRequest", + "headers": [ + { + "description": "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.", + "name": "If-None-Match", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetCutoffTimesRequestIfNoneMatch", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsGetCutoffTimesRequestIfNoneMatch", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 512, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/institutions/{institutionId}/cutoffTimes", + "pathParameters": [ + { + "description": "The unique identifier of a financial institution.", + "name": "institutionId", + "schema": { + "description": null, + "generatedName": "InstitutionsGetCutoffTimesRequestInstitutionId", + "groupName": null, + "nameOverride": null, + "schema": "institutionId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [ + { + "description": "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.", + "name": "timeZoneId", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetCutoffTimesRequestTimeZoneId", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsGetCutoffTimesRequestTimeZoneId", + "groupName": null, + "nameOverride": null, + "schema": "timeZoneId", + "type": "reference", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetCutoffTimesResponse", + "groupName": null, + "nameOverride": null, + "schema": "cutoffTimes", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "institutions", + ], + "methodName": "getCutoffTimes", + }, + "server": [], + "summary": "Return the financial institution's cutoff times for products", + "tags": [ + "Schedules", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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.", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "institutionId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "TIBURON", + }, + }, + }, + ], + "queryParameters": [ + { + "name": "startsOn", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-04", + }, + }, + }, + { + "name": "endsOn", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-04", + }, + }, + }, + ], + "request": null, + "response": { + "properties": { + "accuracyEndsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-12-31T00:00:00.000Z", + }, + }, + "restrictedDates": { + "type": "array", + "value": [ + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-01", + }, + }, + "reason": { + "type": "enum", + "value": "pastDate", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-02", + }, + }, + "reason": { + "type": "enum", + "value": "pastDate", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-03", + }, + }, + "reason": { + "type": "enum", + "value": "pastDate", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-04", + }, + }, + "reason": { + "type": "enum", + "value": "pastDate", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-05", + }, + }, + "reason": { + "type": "enum", + "value": "pastCutoffTime", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-06", + }, + }, + "reason": { + "type": "enum", + "value": "riskRestricted", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-07", + }, + }, + "reason": { + "type": "enum", + "value": "riskRestricted", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-08", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-09", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-10", + }, + }, + "reason": { + "type": "enum", + "value": "holiday", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-15", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-16", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-22", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-23", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-29", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-30", + }, + }, + "reason": { + "type": "enum", + "value": "closure", + }, + }, + "type": "object", + }, + { + "properties": { + "creditOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-07-05", + }, + }, + "debitOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-07", + }, + }, + "occursOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-10-10", + }, + }, + "reason": { + "type": "enum", + "value": "holiday", + }, + }, + "type": "object", + }, + ], + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "InstitutionsGetTransferDateRestrictionsRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/institutions/{institutionId}/transferDateRestrictions", + "pathParameters": [ + { + "description": "The unique identifier of a financial institution.", + "name": "institutionId", + "schema": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestInstitutionId", + "groupName": null, + "nameOverride": null, + "schema": "institutionId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [ + { + "description": "The start of the range of dates to include in the response, in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) 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.", + "name": "startsOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestStartsOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestStartsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "The end of the range of dates to include in the response. in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. The default is at least one year from the \`startOn\` date and is limited to a four year interval.", + "name": "endsOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestEndsOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestEndsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "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.", + "name": "type", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestType", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestType", + "groupName": null, + "nameOverride": null, + "schema": "transferTypeForDateRestrictions", + "type": "reference", + }, + }, + }, + { + "description": "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.", + "name": "risk", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestRisk", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsRequestRisk", + "groupName": null, + "nameOverride": null, + "schema": "achAccountRisk", + "type": "reference", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "InstitutionsGetTransferDateRestrictionsResponse", + "groupName": null, + "nameOverride": null, + "schema": "transferDateRestrictions", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "institutions", + ], + "methodName": "getTransferDateRestrictions", + }, + "server": [], + "summary": "Return the financial institution's transfer dates restrictions", + "tags": [ + "Schedules", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Return a [paginated](https://dx.apiture.com/docs/api-documentation/concepts/pagination) collection of transaction history for this internal account. The [\`nextPage_url\`](https://dx.apiture.com/docs/api-documentation/concepts/links) 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.", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 422, + 429, + 504, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "accountId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "accountId", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "count": { + "type": "primitive", + "value": { + "type": "int", + "value": 2381, + }, + }, + "items": { + "type": "array", + "value": [ + { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "0.00", + }, + }, + "balance": { + "type": "primitive", + "value": { + "type": "string", + "value": "8509.38", + }, + }, + "category": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "id", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "label", + }, + }, + }, + "type": "object", + }, + "check": { + "properties": { + "number": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + }, + "type": "object", + }, + "createdOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-05-18", + }, + }, + "description": { + "type": "primitive", + "value": { + "type": "string", + "value": "description", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "d62c0701-0d74", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "memo", + }, + }, + "occurredOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-06-18", + }, + }, + "posted": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "postedOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-05-18", + }, + }, + "subtype": { + "type": "enum", + "value": "check", + }, + "type": { + "type": "enum", + "value": "balance", + }, + }, + "type": "object", + }, + { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "1276.21", + }, + }, + "balance": { + "type": "primitive", + "value": { + "type": "string", + "value": "8509.38", + }, + }, + "category": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "127", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Utilities", + }, + }, + }, + "type": "object", + }, + "check": { + "properties": { + "imageBack_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "/accounts/1d16e438-18e0/transactions/88f5bf17-ecc4/images/back/content", + }, + }, + "imageFront_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "/accounts/1d16e438-18e0/transactions/88f5bf17-ecc4/images/front/content", + }, + }, + "number": { + "type": "primitive", + "value": { + "type": "int", + "value": 8412, + }, + }, + }, + "type": "object", + }, + "createdOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-05-18", + }, + }, + "description": { + "type": "primitive", + "value": { + "type": "string", + "value": "description", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88f5bf17-ecc4", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "Paid electric bill", + }, + }, + "merchant": { + "properties": { + "logo_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://BillTedsExcellentElectricCompany.example.com/img/logos/medium.png", + }, + }, + "name": { + "type": "primitive", + "value": { + "type": "string", + "value": "B&T's Excellent Electric Co.", + }, + }, + "website_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://BillTedsExcellentElectricCompany.example.com/", + }, + }, + }, + "type": "object", + }, + "occurredOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-06-18", + }, + }, + "posted": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "postedOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-05-18", + }, + }, + "subtype": { + "type": "enum", + "value": "check", + }, + "type": { + "type": "enum", + "value": "debit", + }, + }, + "type": "object", + }, + { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "1276.21", + }, + }, + "balance": { + "type": "primitive", + "value": { + "type": "string", + "value": "8509.38", + }, + }, + "category": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "127", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Utilities", + }, + }, + }, + "type": "object", + }, + "check": { + "properties": { + "imageBack_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "/accounts/1d16e438-18e0/transactions/88f5bf17-ecc4/images/back/content", + }, + }, + "imageFront_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "/accounts/1d16e438-18e0/transactions/88f5bf17-ecc4/images/front/content", + }, + }, + "number": { + "type": "primitive", + "value": { + "type": "int", + "value": 8412, + }, + }, + }, + "type": "object", + }, + "createdOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-05-18", + }, + }, + "description": { + "type": "primitive", + "value": { + "type": "string", + "value": "description", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88f5bf17-ecc4", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "Paid electric bill", + }, + }, + "merchant": { + "properties": { + "logo_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://BillTedsExcellentElectricCompany.example.com/img/logos/medium.png", + }, + }, + "name": { + "type": "primitive", + "value": { + "type": "string", + "value": "B&T's Excellent Electric Co.", + }, + }, + "website_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://BillTedsExcellentElectricCompany.example.com/", + }, + }, + }, + "type": "object", + }, + "occurredOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-05-18", + }, + }, + "posted": { + "type": "primitive", + "value": { + "type": "boolean", + "value": true, + }, + }, + "postedOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-05-18", + }, + }, + "subtype": { + "type": "enum", + "value": "check", + }, + "type": { + "type": "enum", + "value": "debit", + }, + }, + "type": "object", + }, + ], + }, + "limit": { + "type": "primitive", + "value": { + "type": "int", + "value": 10, + }, + }, + "nextPage_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://production.api.apiture.com/banking/accounts/c9fc25b47d52916fc9ad/transactions?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10", + }, + }, + "start": { + "type": "primitive", + "value": { + "type": "string", + "value": "d1b48af913464aa49fcb07065dcc0616", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "TransactionsListTransactionsRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/accounts/{accountId}/transactions", + "pathParameters": [ + { + "description": "The unique identifier of this account resource. This is an opaque string.", + "name": "accountId", + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestAccountId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [ + { + "description": "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\`.", + "name": "start", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestStart", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestStart", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "The maximum number of items to return in this paged response.", + "name": "limit", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestLimit", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestLimit", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + { + "description": "Return only transactions whose \`occurredOn\` date is in this date range. Dates ranges use dates expressed in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`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: ", + "name": "occurredOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestOccurredOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestOccurredOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "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 transactions because the \`posted\` property is not set on balance transactions, so neither \`true\` or \`false\` match them.", + "name": "posted", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestPosted", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestPosted", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + }, + { + "description": "Return only transactions whose \`createdOn\` date is in this date range. Example date ranges are the same format as the \`occurredOn\` query parameter.
**Warning**: The parameter \`createdOn\` was deprecated on version \`v0.6.0\` of the API. Use the \`?occurredOn=\` query parameter instead. \`createdOn\` will be removed on version \`v0.9.0\` of the API.", + "name": "createdOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestCreatedOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestCreatedOn", + "groupName": null, + "nameOverride": null, + "schema": "dateRange", + "type": "reference", + }, + }, + }, + { + "description": "Return only transactions whose \`postedOn\` date is in this date range. Example date ranges are the same format as the \`occurredOn\` query parameter.
**Warning**: The parameter \`postedOn\` was deprecated on version \`v0.6.0\` of the API. Use the \`?occurredOn=\` query parameter instead. \`postedOn\` will be removed on version \`v0.9.0\` of the API.", + "name": "postedOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestPostedOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestPostedOn", + "groupName": null, + "nameOverride": null, + "schema": "dateRange", + "type": "reference", + }, + }, + }, + { + "description": "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"\`.", + "name": "category", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestCategory", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestCategory", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestCategoryItem", + "groupName": null, + "nameOverride": null, + "schema": "transactionCategoryLabel", + "type": "reference", + }, + }, + }, + }, + { + "description": "Filter transactions to only those whose \`type\` is in this pipe-separated list.", + "name": "type", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestType", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestType", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestTypeItem", + "groupName": null, + "nameOverride": null, + "schema": "transactionType", + "type": "reference", + }, + }, + }, + }, + { + "description": "Filter transactions to only those whose \`subtype\` is in this pipe-separated list.", + "name": "subtype", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestSubtype", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestSubtype", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestSubtypeItem", + "groupName": null, + "nameOverride": null, + "schema": "transactionSubType", + "type": "reference", + }, + }, + }, + }, + { + "description": "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: ", + "name": "amount", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestAmount", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestAmount", + "groupName": null, + "nameOverride": null, + "schema": "amountRange", + "type": "reference", + }, + }, + }, + { + "description": "Return only transactions whose \`check.number\` is in this integer range. Examples: ", + "name": "checkNumber", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestCheckNumber", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestCheckNumber", + "groupName": null, + "nameOverride": null, + "schema": "checkNumberRange", + "type": "reference", + }, + }, + }, + { + "description": "When retrying the operation, pass the \`retryCount\` from the \`incompleteTransactions\` response.", + "name": "retryCount", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestRetryCount", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionsListTransactionsRequestRetryCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "TransactionsListTransactionsResponse", + "groupName": null, + "nameOverride": null, + "schema": "transactions", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "transactions", + ], + "methodName": "listTransactions", + }, + "server": [], + "summary": "Return a collection of transactions", + "tags": [ + "Transactions", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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.", + "errorStatusCode": [ + 400, + 401, + 403, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "items": { + "type": "array", + "value": [ + { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "0399abed-fd3d", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Dining", + }, + }, + "type": { + "type": "enum", + "value": "debit", + }, + }, + "type": "object", + }, + ], + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "TransactionCategoriesListTransactionCategoriesRequest", + "headers": [ + { + "description": "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.", + "name": "If-None-Match", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransactionCategoriesListTransactionCategoriesRequestIfNoneMatch", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransactionCategoriesListTransactionCategoriesRequestIfNoneMatch", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 512, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/transactionCategories", + "pathParameters": [], + "queryParameters": [], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "TransactionCategoriesListTransactionCategoriesResponse", + "groupName": null, + "nameOverride": null, + "schema": "transactionCategories", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "transactionCategories", + ], + "methodName": "listTransactionCategories", + }, + "server": [], + "summary": "Return a collection of transaction categories", + "tags": [ + "Transaction Categories", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Return a [paginated](https://dx.apiture.com/docs/api-documentation/concepts/pagination) collection of transfers. The [nextPage_url](https://dx.apiture.com/docs/api-documentation/concepts/links) in the response is a pagination link.", + "errorStatusCode": [ + 400, + 401, + 403, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "count": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + "items": { + "type": "array", + "value": [ + { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "275.00", + }, + }, + "createdAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "0399abed-fd3d", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "Cover check for car repair", + }, + }, + "processedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-06-28T021:00:00.000Z", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "creditsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-26", + }, + }, + "debitsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-24", + }, + }, + "frequency": { + "type": "enum", + "value": "once", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-28", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "bd9b7af2-6f9b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Premiere Checking *6789", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "checking", + }, + }, + "type": "object", + }, + "state": { + "type": "enum", + "value": "processed", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88b1ca3e-d0f3", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Personal Savings *4567", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "savings", + }, + }, + "type": "object", + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "updatedBy": { + "type": "primitive", + "value": { + "type": "string", + "value": "updatedBy", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "100.00", + }, + }, + "createdAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "d62c0701-0d74", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "school expenses", + }, + }, + "processedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2024-01-15T09:30:00Z", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "count": { + "type": "primitive", + "value": { + "type": "int", + "value": 9, + }, + }, + "creditsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-08-01", + }, + }, + "debitsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-08-01", + }, + }, + "frequency": { + "type": "enum", + "value": "monthly", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2023-08-01", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "bd9b7af2-6f9b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *6789", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "checking", + }, + }, + "type": "object", + }, + "state": { + "type": "enum", + "value": "scheduled", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "c8396f59-624b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *3456", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "checking", + }, + }, + "type": "object", + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "updatedBy": { + "type": "primitive", + "value": { + "type": "string", + "value": "updatedBy", + }, + }, + }, + "type": "object", + }, + { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "275.00", + }, + }, + "createdAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "id", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "memo", + }, + }, + "processedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2026-06-26T021:00:00.000Z", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "creditsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-26", + }, + }, + "debitsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-24", + }, + }, + "frequency": { + "type": "enum", + "value": "once", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-28", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "bd9b7af2-6f9b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *1008", + }, + }, + }, + "type": "object", + }, + "state": { + "type": "enum", + "value": "unscheduled", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88b1ca3e-d0f3", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Personal Savings *4567", + }, + }, + "type": { + "type": "enum", + "value": "savings", + }, + }, + "type": "object", + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "updatedBy": { + "type": "primitive", + "value": { + "type": "string", + "value": "James Bond", + }, + }, + }, + "type": "object", + }, + ], + }, + "limit": { + "type": "primitive", + "value": { + "type": "int", + "value": 10, + }, + }, + "nextPage_url": { + "type": "primitive", + "value": { + "type": "string", + "value": "https://production.api.apiture.com/transfers/transfers?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10", + }, + }, + "start": { + "type": "primitive", + "value": { + "type": "string", + "value": "d1b48af913464aa49fcb07065dcc0616", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "TransfersListTransfersRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/transfers", + "pathParameters": [], + "queryParameters": [ + { + "description": "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](https://tools.ietf.org/html/rfc3339) \`date\` format. Example date ranges: ", + "name": "scheduledOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersListTransfersRequestScheduledOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersListTransfersRequestScheduledOn", + "groupName": null, + "nameOverride": null, + "schema": "dateRange", + "type": "reference", + }, + }, + }, + { + "description": "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](https://tools.ietf.org/html/rfc3339) \`date\` format. See the \`scheduledOn\` query parameter for examples.", + "name": "debitsOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersListTransfersRequestDebitsOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersListTransfersRequestDebitsOn", + "groupName": null, + "nameOverride": null, + "schema": "dateRange", + "type": "reference", + }, + }, + }, + { + "description": "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](https://tools.ietf.org/html/rfc3339) \`date\` format. See the \`scheduledOn\` query parameter for examples.", + "name": "creditsOn", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersListTransfersRequestCreditsOn", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersListTransfersRequestCreditsOn", + "groupName": null, + "nameOverride": null, + "schema": "dateRange", + "type": "reference", + }, + }, + }, + { + "description": "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.", + "name": "historical", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersListTransfersRequestHistorical", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersListTransfersRequestHistorical", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + }, + { + "description": "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\`.", + "name": "start", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersListTransfersRequestStart", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersListTransfersRequestStart", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "description": "The maximum number of items to return in this paged response.", + "name": "limit", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersListTransfersRequestLimit", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersListTransfersRequestLimit", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "TransfersListTransfersResponse", + "groupName": null, + "nameOverride": null, + "schema": "transfers", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "transfers", + ], + "methodName": "listTransfers", + }, + "server": [], + "summary": "Return a collection of transfers", + "tags": [ + "Transfers", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "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\`](#op-patchTransfer) operation. + +Note: This operation requires an identity challenge if the financial institution requires the user to proove their identity for some types of transfers. See the "Challenges API".", + "errorStatusCode": [ + 400, + 401, + 403, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [], + "queryParameters": [], + "request": { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "275.00", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "Cover check for car repair", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "frequency": { + "type": "enum", + "value": "once", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-06-28", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "bd9b7af2-6f9b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *1008", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + }, + "type": "object", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88b1ca3e-d0f3", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *1008", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + }, + "type": "object", + }, + }, + "type": "object", + }, + "response": { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "275.00", + }, + }, + "createdAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "0399abed-fd3d", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "Cover check for car repair", + }, + }, + "processedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2024-01-15T09:30:00Z", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "count": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + "creditsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-26", + }, + }, + "debitsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-24", + }, + }, + "endsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "endsOn", + }, + }, + "frequency": { + "type": "enum", + "value": "once", + }, + "recurrenceType": { + "type": "enum", + "value": "fixed", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-28", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "bd9b7af2-6f9b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Premiere Checking *6789", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "checking", + }, + }, + "type": "object", + }, + "state": { + "type": "enum", + "value": "unscheduled", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88b1ca3e-d0f3", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Personal Savings *4567", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "savings", + }, + }, + "type": "object", + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "updatedBy": { + "type": "primitive", + "value": { + "type": "string", + "value": "updatedBy", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "TransfersCreateTransferRequest", + "headers": [ + { + "description": "This operation may require a completed challenge. If the first attempt calling this operation fails with a 401 \`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 401 status code and the \`invalidChallengeHeader\` problem type.", + "name": "Challenge", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersCreateTransferRequestChallenge", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersCreateTransferRequestChallenge", + "groupName": null, + "nameOverride": null, + "schema": "challengeToken", + "type": "reference", + }, + }, + }, + ], + "internal": null, + "method": "POST", + "operationId": null, + "path": "/transfers", + "pathParameters": [], + "queryParameters": [], + "request": { + "contentType": null, + "description": null, + "schema": { + "description": null, + "generatedName": "TransfersCreateTransferRequestBody", + "groupName": null, + "nameOverride": null, + "schema": "newTransfer", + "type": "reference", + }, + "type": "json", + }, + "requestNameOverride": null, + "response": { + "description": "Created.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "TransfersCreateTransferResponse", + "groupName": null, + "nameOverride": null, + "schema": "transfer", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "transfers", + ], + "methodName": "createTransfer", + }, + "server": [], + "summary": "Create a new transfer", + "tags": [ + "Transfers", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Return the JSON representation of this transfer resource.", + "errorStatusCode": [ + 401, + 403, + 404, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "transferId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "transferId", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "275.00", + }, + }, + "createdAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "0399abed-fd3d", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "Cover check for car repair", + }, + }, + "processedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2024-01-15T09:30:00Z", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "count": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + "creditsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-26", + }, + }, + "debitsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-24", + }, + }, + "endsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "endsOn", + }, + }, + "frequency": { + "type": "enum", + "value": "once", + }, + "recurrenceType": { + "type": "enum", + "value": "fixed", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-28", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "bd9b7af2-6f9b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Premiere Checking *6789", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "checking", + }, + }, + "type": "object", + }, + "state": { + "type": "enum", + "value": "unscheduled", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88b1ca3e-d0f3", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Personal Savings *4567", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "savings", + }, + }, + "type": "object", + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "updatedBy": { + "type": "primitive", + "value": { + "type": "string", + "value": "updatedBy", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "TransfersGetTransferRequest", + "headers": [], + "internal": null, + "method": "GET", + "operationId": null, + "path": "/transfers/{transferId}", + "pathParameters": [ + { + "description": "The unique identifier of this transfer. This is an opaque string.", + "name": "transferId", + "schema": { + "description": null, + "generatedName": "TransfersGetTransferRequestTransferId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": null, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "TransfersGetTransferResponse", + "groupName": null, + "nameOverride": null, + "schema": "transfer", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "transfers", + ], + "methodName": "getTransfer", + }, + "server": [], + "summary": "Fetch a representation of this transfer", + "tags": [ + "Transfers", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Delete this transfer resource and any resources that are owned by it. Only transfers that have not been processed may be deleted.", + "errorStatusCode": [ + 401, + 403, + 404, + 409, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "transferId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "transferId", + }, + }, + }, + ], + "queryParameters": [], + "request": null, + "response": null, + }, + ], + "generatedRequestName": "TransfersDeleteTransferRequest", + "headers": [], + "internal": null, + "method": "DELETE", + "operationId": null, + "path": "/transfers/{transferId}", + "pathParameters": [ + { + "description": "The unique identifier of this transfer. This is an opaque string.", + "name": "transferId", + "schema": { + "description": null, + "generatedName": "TransfersDeleteTransferRequestTransferId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": null, + "requestNameOverride": null, + "response": null, + "sdkName": { + "groupName": [ + "transfers", + ], + "methodName": "deleteTransfer", + }, + "server": [], + "summary": "Delete this transfer resource", + "tags": [ + "Transfers", + ], + }, + { + "audiences": [], + "authed": true, + "availability": null, + "description": "Perform a partial update of this transfer as per [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7396) 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".", + "errorStatusCode": [ + 400, + 401, + 403, + 404, + 422, + ], + "examples": [ + { + "codeSamples": [], + "description": null, + "headers": [], + "name": null, + "pathParameters": [ + { + "name": "transferId", + "value": { + "type": "primitive", + "value": { + "type": "string", + "value": "transferId", + }, + }, + }, + ], + "queryParameters": [], + "request": { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "275.00", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "frequency": { + "type": "enum", + "value": "once", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2022-06-28", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "e821ce54-c715", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Premiere Checking *6789", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "checking", + }, + }, + "type": "object", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88b1ca3e-d0f3", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Checking *1008", + }, + }, + }, + "type": "object", + }, + }, + "type": "object", + }, + "response": { + "properties": { + "amount": { + "type": "primitive", + "value": { + "type": "string", + "value": "275.00", + }, + }, + "createdAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "0399abed-fd3d", + }, + }, + "memo": { + "type": "primitive", + "value": { + "type": "string", + "value": "Cover check for car repair", + }, + }, + "processedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2024-01-15T09:30:00Z", + }, + }, + "schedule": { + "properties": { + "amountLimit": { + "type": "primitive", + "value": { + "type": "string", + "value": "3456.78", + }, + }, + "count": { + "type": "primitive", + "value": { + "type": "int", + "value": 1, + }, + }, + "creditsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-26", + }, + }, + "debitsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-24", + }, + }, + "endsOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "endsOn", + }, + }, + "frequency": { + "type": "enum", + "value": "once", + }, + "recurrenceType": { + "type": "enum", + "value": "fixed", + }, + "scheduledOn": { + "type": "primitive", + "value": { + "type": "string", + "value": "2026-06-28", + }, + }, + }, + "type": "object", + }, + "sourceAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "bd9b7af2-6f9b", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Premiere Checking *6789", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "checking", + }, + }, + "type": "object", + }, + "state": { + "type": "enum", + "value": "unscheduled", + }, + "targetAccount": { + "properties": { + "id": { + "type": "primitive", + "value": { + "type": "string", + "value": "88b1ca3e-d0f3", + }, + }, + "label": { + "type": "primitive", + "value": { + "type": "string", + "value": "Personal Savings *4567", + }, + }, + "location": { + "type": "enum", + "value": "internal", + }, + "type": { + "type": "enum", + "value": "savings", + }, + }, + "type": "object", + }, + "updatedAt": { + "type": "primitive", + "value": { + "type": "datetime", + "value": "2022-04-18T07:21:35.375Z", + }, + }, + "updatedBy": { + "type": "primitive", + "value": { + "type": "string", + "value": "updatedBy", + }, + }, + }, + "type": "object", + }, + }, + ], + "generatedRequestName": "TransfersPatchTransferRequest", + "headers": [ + { + "description": "This operation may require a completed challenge. If the first attempt calling this operation fails with a 401 \`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 401 status code and the \`invalidChallengeHeader\` problem type.", + "name": "Challenge", + "parameterNameOverride": null, + "schema": { + "description": null, + "generatedName": "TransfersPatchTransferRequestChallenge", + "groupName": null, + "nameOverride": null, + "type": "nullable", + "value": { + "description": null, + "generatedName": "TransfersPatchTransferRequestChallenge", + "groupName": null, + "nameOverride": null, + "schema": "challengeToken", + "type": "reference", + }, + }, + }, + ], + "internal": null, + "method": "PATCH", + "operationId": null, + "path": "/transfers/{transferId}", + "pathParameters": [ + { + "description": "The unique identifier of this transfer. This is an opaque string.", + "name": "transferId", + "schema": { + "description": null, + "generatedName": "TransfersPatchTransferRequestTransferId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "variableReference": null, + }, + ], + "queryParameters": [], + "request": { + "contentType": null, + "description": null, + "schema": { + "description": null, + "generatedName": "TransfersPatchTransferRequestBody", + "groupName": null, + "nameOverride": null, + "schema": "transferPatch", + "type": "reference", + }, + "type": "json", + }, + "requestNameOverride": null, + "response": { + "description": "OK.", + "responseProperty": null, + "schema": { + "description": null, + "generatedName": "TransfersPatchTransferResponse", + "groupName": null, + "nameOverride": null, + "schema": "transfer", + "type": "reference", + }, + "type": "json", + }, + "sdkName": { + "groupName": [ + "transfers", + ], + "methodName": "patchTransfer", + }, + "server": [], + "summary": "Update this transfer", + "tags": [ + "Transfers", + ], + }, + ], + "errors": { + "400": { + "description": null, + "generatedName": "BadRequestError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "BadRequestErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + "401": { + "description": null, + "generatedName": "UnauthorizedError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "UnauthorizedErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + "403": { + "description": null, + "generatedName": "ForbiddenError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "ForbiddenErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + "404": { + "description": null, + "generatedName": "NotFoundError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "NotFoundErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + "409": { + "description": null, + "generatedName": "ConflictError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "ConflictErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + "422": { + "description": null, + "generatedName": "UnprocessableEntityError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "UnprocessableEntityErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + "429": { + "description": null, + "generatedName": "TooManyRequestsError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "TooManyRequestsErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + "503": { + "description": null, + "generatedName": "ServiceUnavailableError", + "nameOverride": null, + "schema": { + "description": null, + "generatedName": "ServiceUnavailableErrorBody", + "groupName": null, + "nameOverride": null, + "schema": "problemResponse", + "type": "reference", + }, + }, + }, + "globalHeaders": null, + "hasEndpointsMarkedInternal": false, + "nonRequestReferencedSchemas": [ + "productType", + "accountAllowsFilter", + "accounts", + "resourceId", + "account", + "accountIds", + "accountBalances", + "accountJointOwners", + "achSecCode", + "eligibleOverdraftAccounts", + "overdraftProtection", + "jointOwnerInvitation", + "institutionLocatorType", + "institutionLookupResult", + "institutionId", + "transferScheduleDirection", + "transferFrequency", + "transferSchedules", + "timeZoneId", + "cutoffTimes", + "transferTypeForDateRestrictions", + "achAccountRisk", + "transferDateRestrictions", + "dateRange", + "transactionCategoryLabel", + "transactionType", + "transactionSubType", + "amountRange", + "checkNumberRange", + "transactions", + "transactionCategories", + "transfers", + "challengeToken", + "transfer", + "accountPermissions", + "abstractBody", + "readOnlyResourceId", + "accountNickname", + "maskedAccountNumber", + "productReference", + "accountLocation", + "accountFields", + "fullAccountPermissions", + "overdraftAccountFields", + "abstractPagedBody", + "overdraftProtectionFields", + "accountItem", + "accountBalance", + "creditOrDebitValue", + "readOnlyTimestamp", + "accountJointOwner", + "jointOwnerInvitationFields", + "address", + "simpleInstitution", + "cutoffTime", + "cutoffTimeType", + "transferScheduleItem", + "transferDateRestriction", + "transferDateRestrictionType", + "positiveIntegerRange", + "transactionCategorization", + "transactionMerchant", + "transactionCheck", + "transactionFields", + "transactionItem", + "transactionCategoryType", + "transactionCategory", + "transferRecurrenceType", + "monetaryValue", + "transferSchedule", + "transferAccountReference", + "transferFields", + "timestampFields", + "transferItemSchedule", + "transferState", + "transferItem", + "apiProblem", + "abstractPagedBodyFields", + "addressFields", + "challengeFactor", + "challengeFactorType", + "challengeSecurityQuestions", + "challengeSecurityQuestion", + "challengePromptId", + "problemResponse", + ], + "schemas": { + "abstractBody": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "An abstract schema used to define other request and response body model schemas.", + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "properties": [], + "type": "object", + }, + "abstractPagedBody": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "AbstractPagedBodyFields", + "groupName": null, + "nameOverride": null, + "schema": "abstractPagedBodyFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "An abstract schema used to define paginated collections of resources. Collection classes which extend this schema define an array of \`items\` which represent a page of data.", + "generatedName": "AbstractPagedBody", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "abstractPagedBodyStart", + "key": "start", + "schema": { + "description": null, + "generatedName": "abstractPagedBodyStart", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The opaque cursor that specifies the starting location of this page of items.", + "generatedName": "AbstractPagedBodyStart", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "abstractPagedBodyFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Common properties of collection page responses.", + "generatedName": "AbstractPagedBodyFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "abstractPagedBodyFieldsLimit", + "key": "limit", + "schema": { + "description": "The number of items requested for this page response. The length of the \`items\` array may be less that \`limit\`.", + "generatedName": "AbstractPagedBodyFieldsLimit", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "abstractPagedBodyFieldsNextPageUrl", + "key": "nextPage_url", + "schema": { + "description": null, + "generatedName": "abstractPagedBodyFieldsNextPageUrl", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection.", + "generatedName": "AbstractPagedBodyFieldsNextPageUrl", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 8000, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "account": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "AccountFields", + "groupName": null, + "nameOverride": null, + "schema": "accountFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "An internal customer account.", + "generatedName": "Account", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountAllows", + "key": "allows", + "schema": { + "description": "Flags which indicate the permissions the current authorized user has on this account resource.", + "generatedName": "AccountAllows", + "groupName": null, + "nameOverride": null, + "schema": "fullAccountPermissions", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountElectronicStatements", + "key": "electronicStatements", + "schema": { + "description": "If \`true\`, the customer has opted in to receive account statements electronically.", + "generatedName": "AccountElectronicStatements", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "accountAllowsFilter": { + "description": "Values for the \`?allows=\` filter in [\`listAccounts\`](#op-listAccounts). + +accountAllowsFilter strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
billPayBill Pay:

Include each account where the caller is allowed to use the bill pay feature.

+
transferFromTransfer From:

Include each account where the caller is allowed to transfer money from the account.

+
transferToTransfer To:

Include each account where the caller is allowed to transfer money into the account.

+
mobileCheckDepositMobile Check Deposit:

Include each account where the caller is allowed to deposit mobile checks.

+
viewView:

Include each account where the caller is allowed to view full account details (balances, full account number, transactions, etc).

+
viewCardsView Cards:

Include each account where the caller is allowed to view debit card details.

+
manageCardsManage Cards:

Include each account where the caller is allowed to manage debit card details.

+
+ +", + "generatedName": "AccountAllowsFilter", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "billPay", + "nameOverride": null, + "value": "billPay", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "transferFrom", + "nameOverride": null, + "value": "transferFrom", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "transferTo", + "nameOverride": null, + "value": "transferTo", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "mobileCheckDeposit", + "nameOverride": null, + "value": "mobileCheckDeposit", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "view", + "nameOverride": null, + "value": "view", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "viewCards", + "nameOverride": null, + "value": "viewCards", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "manageCards", + "nameOverride": null, + "value": "manageCards", + }, + ], + }, + "accountBalance": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "The current balances of the given account.", + "generatedName": "AccountBalance", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountBalanceId", + "key": "id", + "schema": { + "description": "The account ID.", + "generatedName": "AccountBalanceId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountBalanceAvailable", + "key": "available", + "schema": { + "description": null, + "generatedName": "accountBalanceAvailable", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The available balance: the funds available for use. This is the string representation of the exact decimal amount.", + "generatedName": "AccountBalanceAvailable", + "groupName": null, + "nameOverride": null, + "schema": "creditOrDebitValue", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountBalanceCurrent", + "key": "current", + "schema": { + "description": null, + "generatedName": "accountBalanceCurrent", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The current balance. This is the balance at the end of the previous business day. This is the string representation of the exact decimal amount.", + "generatedName": "AccountBalanceCurrent", + "groupName": null, + "nameOverride": null, + "schema": "creditOrDebitValue", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountBalanceUpdatedAt", + "key": "updatedAt", + "schema": { + "description": null, + "generatedName": "accountBalanceUpdatedAt", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The time when the balance values were last updated from the banking core.", + "generatedName": "AccountBalanceUpdatedAt", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyTimestamp", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountBalanceCurrentWithPending", + "key": "currentWithPending", + "schema": { + "description": null, + "generatedName": "accountBalanceCurrentWithPending", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The current balance, with posted transactions. This is the string representation of the exact decimal amount.", + "generatedName": "AccountBalanceCurrentWithPending", + "groupName": null, + "nameOverride": null, + "schema": "creditOrDebitValue", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountBalanceIncomplete", + "key": "incomplete", + "schema": { + "description": "If \`true\`, the response is incomplete and the client may retry the operation after the \`Retry-After\` time in order to fetch balances for any incomplete accounts in the \`items\`. The retry operation should only pass in accounts that are \`incomplete\`.", + "generatedName": "AccountBalanceIncomplete", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "accountBalances": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "An array of account balances by account ID.", + "generatedName": "AccountBalances", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountBalancesItems", + "key": "items", + "schema": { + "description": "An array of items, one for each of the \`?accounts=\` in the request, returned in the same order.", + "generatedName": "AccountBalancesItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "AccountBalancesItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "accountBalance", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "accountFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Fragment schema use to build other account schemas.", + "generatedName": "AccountFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountFieldsId", + "key": "id", + "schema": { + "description": "The unique identifier for this account resource. This is an immutable opaque string.", + "generatedName": "AccountFieldsId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountFieldsLabel", + "key": "label", + "schema": { + "description": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", + "generatedName": "AccountFieldsLabel", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 80, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountFieldsNickname", + "key": "nickname", + "schema": { + "description": null, + "generatedName": "accountFieldsNickname", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "AccountFieldsNickname", + "groupName": null, + "nameOverride": null, + "schema": "accountNickname", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountFieldsMaskedNumber", + "key": "maskedNumber", + "schema": { + "description": null, + "generatedName": "AccountFieldsMaskedNumber", + "groupName": null, + "nameOverride": null, + "schema": "maskedAccountNumber", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountFieldsProduct", + "key": "product", + "schema": { + "description": null, + "generatedName": "AccountFieldsProduct", + "groupName": null, + "nameOverride": null, + "schema": "productReference", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountFieldsLocation", + "key": "location", + "schema": { + "description": "Indicates where an account is held.", + "generatedName": "AccountFieldsLocation", + "groupName": null, + "nameOverride": null, + "schema": "accountLocation", + "type": "reference", + }, + }, + ], + "type": "object", + }, + "accountIds": { + "description": "An array of account IDs.", + "generatedName": "AccountIds", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "AccountIdsItem", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + }, + "accountItem": { + "allOf": [ + { + "description": null, + "generatedName": "AccountFields", + "groupName": null, + "nameOverride": null, + "schema": "accountFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "An account item in a list items in the \`accounts\` schema.", + "generatedName": "AccountItem", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": { + "accountFields": { + "differentSchema": true, + }, + }, + "generatedName": "accountItemId", + "key": "id", + "schema": { + "description": null, + "generatedName": "accountItemId", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The unique identifier for this account resource. This is an immutable opaque string.", + "generatedName": "AccountItemId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": { + "accountFields": { + "differentSchema": true, + }, + }, + "generatedName": "accountItemLabel", + "key": "label", + "schema": { + "description": null, + "generatedName": "accountItemLabel", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", + "generatedName": "AccountItemLabel", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 80, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": { + "accountFields": { + "differentSchema": true, + }, + }, + "generatedName": "accountItemNickname", + "key": "nickname", + "schema": { + "description": null, + "generatedName": "accountItemNickname", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "AccountItemNickname", + "groupName": null, + "nameOverride": null, + "schema": "accountNickname", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": { + "accountFields": { + "differentSchema": true, + }, + }, + "generatedName": "accountItemMaskedNumber", + "key": "maskedNumber", + "schema": { + "description": null, + "generatedName": "accountItemMaskedNumber", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "AccountItemMaskedNumber", + "groupName": null, + "nameOverride": null, + "schema": "maskedAccountNumber", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountItemAllows", + "key": "allows", + "schema": { + "description": null, + "generatedName": "AccountItemAllows", + "groupName": null, + "nameOverride": null, + "schema": "accountPermissions", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": { + "accountFields": { + "differentSchema": true, + }, + }, + "generatedName": "accountItemProduct", + "key": "product", + "schema": { + "description": null, + "generatedName": "accountItemProduct", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "AccountItemProduct", + "groupName": null, + "nameOverride": null, + "schema": "productReference", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": { + "accountFields": { + "differentSchema": true, + }, + }, + "generatedName": "accountItemLocation", + "key": "location", + "schema": { + "description": null, + "generatedName": "accountItemLocation", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "Indicates where an account is held.", + "generatedName": "AccountItemLocation", + "groupName": null, + "nameOverride": null, + "schema": "accountLocation", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "accountJointOwner": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "Representation of account joint owner resources.", + "generatedName": "AccountJointOwner", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountJointOwnerId", + "key": "id", + "schema": { + "description": null, + "generatedName": "AccountJointOwnerId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountJointOwnerName", + "key": "name", + "schema": { + "description": "The full name of the joint owner.", + "generatedName": "AccountJointOwnerName", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 50, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "accountJointOwners": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": null, + "generatedName": "AccountJointOwners", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountJointOwnersItems", + "key": "items", + "schema": { + "description": "An array containing account joint owner items.", + "generatedName": "AccountJointOwnersItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "AccountJointOwnersItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "accountJointOwner", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "accountLocation": { + "description": "Indicates where an account is held: + * \`internal\` accounts at the current financial institution; + * \`external\` accounts at another financial institution; + * \`outside\` accounts non-banking accounts such as brokerage and fund accounts. +Account transfers are only allowed between \`internal\` and \`external\` accounts. All accounts are considered when calculating total cash balance.", + "generatedName": "AccountLocation", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "internal", + "nameOverride": null, + "value": "internal", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "external", + "nameOverride": null, + "value": "external", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "outside", + "nameOverride": null, + "value": "outside", + }, + ], + }, + "accountNickname": { + "description": "The nickname (friendly name) the customer has given this account. Each customer can define their own nickname for the same account. If omitted, the customer has not set a nickname.", + "generatedName": "AccountNickname", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 50, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + "accountPermissions": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Flags which indicate the permissions the current authorized user has on this account item resource. Most of these properties may only be \`true\` for internal accounts. These permissions are available in account items in the [\`accounts\`](#schema-accounts) list. See [\`fullAccountPermissions\`](#schema-fullAccountPermissions) for all capabilities a customer has on an account (the \`account.allows\` object in the [\`account\`](#schema-account) object response from [\`getAccount\`](#op-getAccount).)", + "generatedName": "AccountPermissions", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountPermissionsBillPay", + "key": "billPay", + "schema": { + "description": "If \`true\`, the customer may use this account for Bill Pay.", + "generatedName": "AccountPermissionsBillPay", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountPermissionsMobileCheckDeposit", + "key": "mobileCheckDeposit", + "schema": { + "description": "If \`true\`, the customer may use this account for mobile check deposits.", + "generatedName": "AccountPermissionsMobileCheckDeposit", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountPermissionsTransferFrom", + "key": "transferFrom", + "schema": { + "description": "If \`true\`, the customer may use this account as the target (deposit) account for account-to-account transfers.", + "generatedName": "AccountPermissionsTransferFrom", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountPermissionsTransferTo", + "key": "transferTo", + "schema": { + "description": "If \`true\`, the customer may use this account as the source (debit) account for account-to-account transfers.", + "generatedName": "AccountPermissionsTransferTo", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountPermissionsView", + "key": "view", + "schema": { + "description": "If \`true\`, the customer may view the details of this account, including the account balance and transactions.", + "generatedName": "AccountPermissionsView", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountPermissionsViewCards", + "key": "viewCards", + "schema": { + "description": "If \`true\`, the customer may view debit cards associated with this account.", + "generatedName": "AccountPermissionsViewCards", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountPermissionsManageCards", + "key": "manageCards", + "schema": { + "description": "If true, the customer may manage debit cards associated with this account. This includes locking and unlocking cards, changing card controls, ordering cards, or canceling cards.", + "generatedName": "AccountPermissionsManageCards", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "accountRoutingNumber": { + "description": "An account ABA routing and transit number.", + "generatedName": "AccountRoutingNumber", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 9, + "minLength": 9, + "type": "string", + }, + "type": "primitive", + }, + "accounts": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractPagedBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractPagedBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "A paginated list of the customer's accounts. This list contains internal banking accounts and external banking accounts. and outside fund accounts. The \`location\` property indicates where the account is held. Items in the list contain \`url\` links to the actual account resource which are in the \`accounts\`, \`externalAccounts\` or \`outsideAccounts\` collections.", + "generatedName": "Accounts", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "accountsItems", + "key": "items", + "schema": { + "description": "The array of items in this page of accounts. This array may be empty.", + "generatedName": "AccountsItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "AccountsItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "accountItem", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountsCount", + "key": "count", + "schema": { + "description": null, + "generatedName": "accountsCount", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The total number of accounts for which the user has access. This value ignores any filters. This value is _optional_ and may be omitted if the count is not computable efficiently.", + "generatedName": "AccountsCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "accountsPrimaryAccountId", + "key": "primaryAccountId", + "schema": { + "description": null, + "generatedName": "accountsPrimaryAccountId", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The \`id\` of the customer's primary account. This property only exists for retail customers, and only if the customer has designated a primary account.", + "generatedName": "AccountsPrimaryAccountId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": { + "abstractPagedBody": { + "differentSchema": true, + }, + }, + "generatedName": "accountsNextPageUrl", + "key": "nextPage_url", + "schema": { + "description": null, + "generatedName": "accountsNextPageUrl", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The URL of the next page of accounts. If this URL is omitted, there are no more accounts.", + "generatedName": "AccountsNextPageUrl", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "achAccountRisk": { + "description": "Describes the risk level of a payment batch's settlement account. + +achAccountRisk strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + +
ValueDescription
earlyEarly:

The account is debited three business days before the ACH transfer's effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with an early risk level.

+
normalNormal:

The account is debited two business days before the ACH transfer's effective date. The account balance is also checked for sufficient funds before the account is debited. A risk limit may apply for commercial accounts with a normal risk level.

+
floatFloat:

The account is debited on the ACH transfer's effective date. The account balance is not checked for sufficient funds before the account is debited. A risk limit applies for commercial accounts with a float risk level.

+
sameDaySame Day:

The account is credited on the ACH transfer's effective day. The account balance is not checked because sameDay is used for credit. A risk limit and per-transaction limit applies.

+
+ +", + "generatedName": "AchAccountRisk", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "early", + "nameOverride": null, + "value": "early", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "normal", + "nameOverride": null, + "value": "normal", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "float", + "nameOverride": null, + "value": "float", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "sameDay", + "nameOverride": null, + "value": "sameDay", + }, + ], + }, + "achSecCode": { + "description": "The ACH transfer type. + +achSecCode strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
arcAccounts Receivable
bocBack Office Conversion
ccdCredit or Debit
cieCustomer-Initiated
ctxCorporate Trade Exchange
popPoint of Purchase
ppdPrearranged Payment and Deposit
rckRe-Presented Check
telTelephone-initiated
webInternet-initiated/Mobile
+ +", + "generatedName": "AchSecCode", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "arc", + "nameOverride": null, + "value": "arc", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "boc", + "nameOverride": null, + "value": "boc", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "ccd", + "nameOverride": null, + "value": "ccd", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "cie", + "nameOverride": null, + "value": "cie", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "ctx", + "nameOverride": null, + "value": "ctx", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "pop", + "nameOverride": null, + "value": "pop", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "ppd", + "nameOverride": null, + "value": "ppd", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "rck", + "nameOverride": null, + "value": "rck", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "tel", + "nameOverride": null, + "value": "tel", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "web", + "nameOverride": null, + "value": "web", + }, + ], + }, + "address": { + "allOf": [ + { + "description": null, + "generatedName": "AddressFields", + "groupName": null, + "nameOverride": null, + "schema": "addressFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "A postal address that can hold a US address or an international (non-US) postal addresses.", + "generatedName": "Address", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "addressRegionName", + "key": "regionName", + "schema": { + "description": null, + "generatedName": "addressRegionName", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The state, district, or outlying area of the postal address. This is required if \`countryCode\` is not \`US\`. \`regionCode\` and \`regionName\` are mutually exclusive.", + "generatedName": "AddressRegionName", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 20, + "minLength": 2, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "addressRegionCode", + "key": "regionCode", + "schema": { + "description": null, + "generatedName": "addressRegionCode", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The state, district, or outlying area of the postal address. This is required if \`countryCode\` is \`US\` \`regionCode\` and \`regionName\` are mutually exclusive.", + "generatedName": "AddressRegionCode", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 2, + "minLength": 2, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "addressPostalCode", + "key": "postalCode", + "schema": { + "description": "The postal code, which varies in format by country. If \`countryCode\` is \`US\`, this should be a five digit US ZIP code or ten character ZIP+4.", + "generatedName": "AddressPostalCode", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 10, + "minLength": 5, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": { + "addressFields": { + "differentSchema": false, + }, + }, + "generatedName": "addressCountryCode", + "key": "countryCode", + "schema": { + "description": "The [ISO-3611 alpha-2](https://www.iso.org/glossary-for-iso-3166.html) value for the country associated with the postal address.", + "generatedName": "AddressCountryCode", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 2, + "minLength": 2, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "addressFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Properties of a simple address, used to compose other addresses.", + "generatedName": "AddressFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "addressFieldsAddress1", + "key": "address1", + "schema": { + "description": "The first line of the postal address. In the US, this typically includes the building number and street name.", + "generatedName": "AddressFieldsAddress1", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 35, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "addressFieldsAddress2", + "key": "address2", + "schema": { + "description": null, + "generatedName": "addressFieldsAddress2", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address.", + "generatedName": "AddressFieldsAddress2", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 35, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "addressFieldsLocality", + "key": "locality", + "schema": { + "description": "The city/town/municipality of the address.", + "generatedName": "AddressFieldsLocality", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 20, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "addressFieldsCountryCode", + "key": "countryCode", + "schema": { + "description": "The [ISO-3611 alpha-2](https://www.iso.org/glossary-for-iso-3166.html) value for the country associated with the postal address.", + "generatedName": "AddressFieldsCountryCode", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 2, + "minLength": 2, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "amountRange": { + "description": "A monetary amount range, supporting inclusive or exclusive endpoints. The value may have the following forms: ", + "generatedName": "AmountRange", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + "apiProblem": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).", + "generatedName": "ApiProblem", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemType", + "key": "type", + "schema": { + "description": null, + "generatedName": "apiProblemType", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "A [URI reference (RFC3986)](https://tools.ietf.org/html/rfc3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be \`"about:blank"\`. +", + "generatedName": "ApiProblemType", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemTitle", + "key": "title", + "schema": { + "description": null, + "generatedName": "apiProblemTitle", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "A short, human-readable summary of the problem type. The title is usually the same for all problem with the same \`type\`. +", + "generatedName": "ApiProblemTitle", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemStatus", + "key": "status", + "schema": { + "description": null, + "generatedName": "apiProblemStatus", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6) for this occurrence of the problem. +", + "generatedName": "ApiProblemStatus", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemDetail", + "key": "detail", + "schema": { + "description": null, + "generatedName": "apiProblemDetail", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "A human-readable explanation specific to this occurrence of the problem. +", + "generatedName": "ApiProblemDetail", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemInstance", + "key": "instance", + "schema": { + "description": null, + "generatedName": "apiProblemInstance", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment +", + "generatedName": "ApiProblemInstance", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemId", + "key": "id", + "schema": { + "description": null, + "generatedName": "apiProblemId", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The unique identifier for this problem. This is an immutable opaque string.", + "generatedName": "ApiProblemId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemOccurredAt", + "key": "occurredAt", + "schema": { + "description": null, + "generatedName": "apiProblemOccurredAt", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The timestamp when the problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC.", + "generatedName": "ApiProblemOccurredAt", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyTimestamp", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemProblems", + "key": "problems", + "schema": { + "description": null, + "generatedName": "apiProblemProblems", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "Optional root-causes if there are multiple problems in the request or API call processing.", + "generatedName": "ApiProblemProblems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "ApiProblemProblemsItem", + "groupName": null, + "nameOverride": null, + "schema": "apiProblem", + "type": "reference", + }, + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "apiProblemAttributes", + "key": "attributes", + "schema": { + "description": null, + "generatedName": "apiProblemAttributes", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.", + "generatedName": "ApiProblemAttributes", + "groupName": null, + "key": { + "description": null, + "generatedName": "ApiProblemAttributesKey", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + }, + "nameOverride": null, + "type": "map", + "value": { + "generatedName": "ApiProblemAttributesValue", + "nameOverride": null, + "type": "unknown", + }, + }, + }, + }, + ], + "type": "object", + }, + "challengeFactor": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "An challenge factor. See [\`requiredIdentityChallenge\`](#schema-requiredIdentityChallenge) for multiple examples.", + "generatedName": "ChallengeFactor", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "challengeFactorType", + "key": "type", + "schema": { + "description": null, + "generatedName": "ChallengeFactorType", + "groupName": null, + "nameOverride": null, + "schema": "challengeFactorType", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "challengeFactorLabels", + "key": "labels", + "schema": { + "description": null, + "generatedName": "challengeFactorLabels", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "A list of text label which identifies the channel(s) though which the user completes the challenge. For an \`sms\` or \`voice\` challenge, the only label item is the last four digits of the corresponding phone number. For an \`email\` challenge, each label is the masked email address.", + "generatedName": "ChallengeFactorLabels", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "ChallengeFactorLabelsItem", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 40, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "challengeFactorSecurityQuestions", + "key": "securityQuestions", + "schema": { + "description": null, + "generatedName": "challengeFactorSecurityQuestions", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "ChallengeFactorSecurityQuestions", + "groupName": null, + "nameOverride": null, + "schema": "challengeSecurityQuestions", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "challengeFactorType": { + "description": "The name of challenge factor. + +challengeFactorType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number

+
emailEmail:

One-time passcode sent to the primary email address

+
voiceVoice:

One-time passcode communicated via automated voice phone call

+
authenticatorTokenauthenticator Token:

One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app

+
securityQuestionsSecurity Questions:

Prompt with the user's security questions registered with their security profile

+
+ +", + "generatedName": "ChallengeFactorType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "sms", + "nameOverride": null, + "value": "sms", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "email", + "nameOverride": null, + "value": "email", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "voice", + "nameOverride": null, + "value": "voice", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "securityQuestions", + "nameOverride": null, + "value": "securityQuestions", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "authenticatorToken", + "nameOverride": null, + "value": "authenticatorToken", + }, + ], + }, + "challengePromptId": { + "description": "The unique ID of a prompt (such as a security question) in a challenge factor.", + "generatedName": "ChallengePromptId", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 48, + "minLength": 1, + "type": "string", + }, + "type": "primitive", + }, + "challengeSecurityQuestion": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "A single security question within the \`questions\` array of the [\`challengeSecurityQuestions\`](#schema-challengeSecurityQuestions)", + "generatedName": "ChallengeSecurityQuestion", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "challengeSecurityQuestionId", + "key": "id", + "schema": { + "description": "The unique ID of security question prompt. This should be included in the [\`challengeVerification\`](#schema-challengeVerification) response as the \`promptId\`.", + "generatedName": "ChallengeSecurityQuestionId", + "groupName": null, + "nameOverride": null, + "schema": "challengePromptId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "challengeSecurityQuestionPrompt", + "key": "prompt", + "schema": { + "description": "The text prompt of this security question.", + "generatedName": "ChallengeSecurityQuestionPrompt", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 50, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "challengeSecurityQuestions": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Describes a \`securityQuestions\` challenge. This is omitted if the challenge \`type\` is not \`securityQuestions\`.", + "generatedName": "ChallengeSecurityQuestions", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "challengeSecurityQuestionsQuestions", + "key": "questions", + "schema": { + "description": "The array of security questions.", + "generatedName": "ChallengeSecurityQuestionsQuestions", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "ChallengeSecurityQuestionsQuestionsItem", + "groupName": null, + "nameOverride": null, + "schema": "challengeSecurityQuestion", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "challengeToken": { + "description": "The value of the identity \`Challenge\` request header that the client must send when retrying an operation which required a challenge.", + "generatedName": "ChallengeToken", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 255, + "minLength": 8, + "type": "string", + }, + "type": "primitive", + }, + "checkNumberRange": { + "description": "A numeric range for a checking account check number.", + "generatedName": "CheckNumberRange", + "groupName": null, + "nameOverride": null, + "schema": "positiveIntegerRange", + "type": "reference", + }, + "creditOrDebitValue": { + "description": "The monetary value representing a credit (positive amounts with no prefix or a \`+\` prefix) or debit (negative amounts with a \`-\` prefix). The numeric value is represented as a string so that it can be exact with no loss of precision.
The schema \`creditOrDebitValue\` was added on version \`0.4.0\` of the API.", + "generatedName": "CreditOrDebitValue", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + "cutoffTime": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "A representation of a cutoff time for a money movement process at a financial institution.", + "generatedName": "CutoffTime", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "cutoffTimeType", + "key": "type", + "schema": { + "description": null, + "generatedName": "CutoffTimeType", + "groupName": null, + "nameOverride": null, + "schema": "cutoffTimeType", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "cutoffTimeTime", + "key": "time", + "schema": { + "description": "The cutoff time for a product formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) \`time\` format: \`hh:mm\`. The time is expressed in 24 hour time and is set to the local time zone of the financial institution.", + "generatedName": "CutoffTimeTime", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "cutoffTimeType": { + "description": "Indicates the type of a cutoff time. + +cutoffTimeType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
achACH
sameDayAchSame Day ACH
domesticWireTransferDomestic Wire Transfer
internationalWireTransferInternational Wire Transfer
internalTransferInternal Account Transfer:

A transfer between accounts at the same financial institution

+
externalTransferExternal Account Transfer:

A transfer to or from an account at an external financial institution

+
billPayBill Pay
+ +", + "generatedName": "CutoffTimeType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "ach", + "nameOverride": null, + "value": "ach", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "sameDayAch", + "nameOverride": null, + "value": "sameDayAch", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "domesticWireTransfer", + "nameOverride": null, + "value": "domesticWireTransfer", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "internationalWireTransfer", + "nameOverride": null, + "value": "internationalWireTransfer", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "internalTransfer", + "nameOverride": null, + "value": "internalTransfer", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "externalTransfer", + "nameOverride": null, + "value": "externalTransfer", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "billPay", + "nameOverride": null, + "value": "billPay", + }, + ], + }, + "cutoffTimes": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "A representation of financial institution cutoff times for different money movement processes. A money movement process can have multiple cutoff times. The cutoff times are sorted in ascending chronological order by money movement process.", + "generatedName": "CutoffTimes", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "cutoffTimesTimeZoneId", + "key": "timeZoneId", + "schema": { + "description": "The identifier of the time zone for which all of the \`items[].time\` are returned in. +The client can use this value to localize the \`items[].time\` values to the local time zone of the customer, as well as for formatting to localized names, such as \`EST\` and \`EDT\`.", + "generatedName": "CutoffTimesTimeZoneId", + "groupName": null, + "nameOverride": null, + "schema": "timeZoneId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "cutoffTimesItems", + "key": "items", + "schema": { + "description": "A list of cutoff times for a financial institution.", + "generatedName": "CutoffTimesItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "CutoffTimesItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "cutoffTime", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "dateRange": { + "description": "A date range, supporting inclusive or exclusive endpoints. Dates ranges use dates expressed in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format. The value may have the following forms: ", + "generatedName": "DateRange", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + "eligibleOverdraftAccountItem": { + "description": "An account that is eligible to be assigned as an overdraft protection account for another account.", + "generatedName": "EligibleOverdraftAccountItem", + "groupName": null, + "nameOverride": null, + "schema": "overdraftAccountFields", + "type": "reference", + }, + "eligibleOverdraftAccounts": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractPagedBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractPagedBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "A page of zero or more accounts that are eligible to be assigned as an overdraft protection account for another account.", + "generatedName": "EligibleOverdraftAccounts", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "eligibleOverdraftAccountsItems", + "key": "items", + "schema": { + "generatedName": "EligibleOverdraftAccountsItems", + "nameOverride": null, + "type": "unknown", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "eligibleOverdraftAccountsMaximumOverdraftAccounts", + "key": "maximumOverdraftAccounts", + "schema": { + "description": "The maximum number of overdraft protection accounts that may be linked to the account.", + "generatedName": "EligibleOverdraftAccountsMaximumOverdraftAccounts", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": { + "abstractPagedBody": { + "differentSchema": true, + }, + }, + "generatedName": "eligibleOverdraftAccountsNextPageUrl", + "key": "nextPage_url", + "schema": { + "description": null, + "generatedName": "eligibleOverdraftAccountsNextPageUrl", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The URL of the next page of eligible accounts. If this URL is omitted, there are no more accounts.", + "generatedName": "EligibleOverdraftAccountsNextPageUrl", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 256, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "externalAccountVerificationMethod": { + "description": "The method used to verify the customer has access to the external account. + +externalAccountVerificationMethod strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + +
ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.

+
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.

+
manualManual:

Access to the external account is verified manually by the financial institution.

+
+ +", + "generatedName": "ExternalAccountVerificationMethod", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "instant", + "nameOverride": null, + "value": "instant", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "microDeposits", + "nameOverride": null, + "value": "microDeposits", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "manual", + "nameOverride": null, + "value": "manual", + }, + ], + }, + "fullAccountNumber": { + "description": "A full account number. This is the number that the customer uses to reference the account within the financial institution.", + "generatedName": "FullAccountNumber", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 32, + "minLength": 1, + "type": "string", + }, + "type": "primitive", + }, + "fullAccountPermissions": { + "allOf": [ + { + "description": null, + "generatedName": "AccountPermissions", + "groupName": null, + "nameOverride": null, + "schema": "accountPermissions", + }, + ], + "allOfPropertyConflicts": [], + "description": "Flags which indicate the permissions the current authorized user has on this account resource. Most of these properties may only be \`true\` for internal accounts. These permissions are available in [\`account\`](#schema-account) response from the [\`getAccount\`](#op-getAccount) operation. See [\`accountPermissions\`](#schema-accountPermissions) for the subset of permission in \`account.allows\` flags in the [\`listAccounts\`](#op-listAccounts) response.", + "generatedName": "FullAccountPermissions", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "fullAccountPermissionsManageJointOwners", + "key": "manageJointOwners", + "schema": { + "description": "If \`true\`, the customer can list the other joint owners on the account and invite new joint owners.", + "generatedName": "FullAccountPermissionsManageJointOwners", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "fullAccountPermissionsManageOverdraftAccounts", + "key": "manageOverdraftAccounts", + "schema": { + "description": "If \`true\`, the customer can list and manage overdraft account settings.", + "generatedName": "FullAccountPermissionsManageOverdraftAccounts", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "incompleteAccountBalances": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "An array of account balances by account ID, some of which are incomplete. Use the values in \`incompleteAccounts\` and \`retryCount\` to retry the [\`listAccountBalances\`](#op-listAccountBalances) operation.", + "generatedName": "IncompleteAccountBalances", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "incompleteAccountBalancesItems", + "key": "items", + "schema": { + "description": "An array of items, one for each of the \`?accounts=\` in the request, returned in the same order.", + "generatedName": "IncompleteAccountBalancesItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "IncompleteAccountBalancesItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "accountBalance", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "incompleteAccountBalancesIncompleteAccounts", + "key": "incompleteAccounts", + "schema": { + "description": "Pass these values as the \`?accounts=\` query parameter on the next retry of the [\`listAccountBalances\`](#op-listAccountBalances) operation. This value is empty if the client has reached the retry limit.", + "generatedName": "IncompleteAccountBalancesIncompleteAccounts", + "groupName": null, + "nameOverride": null, + "schema": "accountIds", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "incompleteAccountBalancesRetryCount", + "key": "retryCount", + "schema": { + "description": "Pass this value as the as the \`?retryCount=\` parameter with the next retry of the [\`listAccountBalances\`](#op-listAccountBalances) operation.", + "generatedName": "IncompleteAccountBalancesRetryCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "incompleteTransactions": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "Response when requesting transactions that are not yet available.", + "generatedName": "IncompleteTransactions", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "incompleteTransactionsRetryCount", + "key": "retryCount", + "schema": { + "description": "Pass this value as the as the \`?retryCount=\` parameter with the next retry of the [\`listTransactions\`](#op-listTransactions) operation.", + "generatedName": "IncompleteTransactionsRetryCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "institutionId": { + "description": "The unique immutable identifier of a financial institution.", + "generatedName": "InstitutionId", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 9, + "minLength": 2, + "type": "string", + }, + "type": "primitive", + }, + "institutionLocatorType": { + "description": "Indicates the type of the institution \`locator\`. + +institutionLocatorType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + +
ValueDescription
abaRoutingNumberABA Routing Number:

The American Bankers Association routing number of a financial institution

+
swiftBicCodeswiftBicCode:

The SWIFT Business Identifier Code (BIC) code of a financial institution

+
ibanAccountNumberIBAN:

International Bank Account Number (IBAN)

+
+ +", + "generatedName": "InstitutionLocatorType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "abaRoutingNumber", + "nameOverride": null, + "value": "abaRoutingNumber", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "swiftBicCode", + "nameOverride": null, + "value": "swiftBicCode", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "ibanAccountNumber", + "nameOverride": null, + "value": "ibanAccountNumber", + }, + ], + }, + "institutionLookupResult": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "Successful institution lookup result.", + "generatedName": "InstitutionLookupResult", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "institutionLookupResultFound", + "key": "found", + "schema": { + "description": "\`true\` if a financial institution was found matching the requested FI locator, \`false\` if none was found.", + "generatedName": "InstitutionLookupResultFound", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "institutionLookupResultInstitution", + "key": "institution", + "schema": { + "description": null, + "generatedName": "institutionLookupResultInstitution", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The name and other information about the financial institution, if found.", + "generatedName": "InstitutionLookupResultInstitution", + "groupName": null, + "nameOverride": null, + "schema": "simpleInstitution", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "institutionLookupResultIntermediaryInstitutions", + "key": "intermediaryInstitutions", + "schema": { + "description": null, + "generatedName": "institutionLookupResultIntermediaryInstitutions", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "Optional intermediary institutions, if requested and if intermediary institutions are required for for international wire transfers to the beneficiary institution. This array is omitted if there none are required.", + "generatedName": "InstitutionLookupResultIntermediaryInstitutions", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "InstitutionLookupResultIntermediaryInstitutionsItem", + "groupName": null, + "nameOverride": null, + "schema": "simpleInstitution", + "type": "reference", + }, + }, + }, + }, + ], + "type": "object", + }, + "jointOwnerInvitation": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "JointOwnerInvitationFields", + "groupName": null, + "nameOverride": null, + "schema": "jointOwnerInvitationFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "A joint owner invitation.", + "generatedName": "JointOwnerInvitation", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "jointOwnerInvitationId", + "key": "id", + "schema": { + "description": "The unique ID of the invitation.", + "generatedName": "JointOwnerInvitationId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + ], + "type": "object", + }, + "jointOwnerInvitationFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Fields used to compose other joint owner invitation schemas.", + "generatedName": "JointOwnerInvitationFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "jointOwnerInvitationFieldsFirstName", + "key": "firstName", + "schema": { + "description": "The invitee's first name.", + "generatedName": "JointOwnerInvitationFieldsFirstName", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 32, + "minLength": 1, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "jointOwnerInvitationFieldsLastName", + "key": "lastName", + "schema": { + "description": "The invitee's last name name.", + "generatedName": "JointOwnerInvitationFieldsLastName", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 32, + "minLength": 1, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "jointOwnerInvitationFieldsTaxId", + "key": "taxId", + "schema": { + "description": null, + "generatedName": "jointOwnerInvitationFieldsTaxId", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The last 4 digits of the invitee's tax ID number (Social Security Number). This is not sent in the invitation email, but if the invitee enrolls in digital banking, this identification must match the last four digits of the tax ID they use to enroll.", + "generatedName": "JointOwnerInvitationFieldsTaxId", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 4, + "minLength": 4, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "jointOwnerInvitationFieldsSharedSecret", + "key": "sharedSecret", + "schema": { + "description": "A string shared by the inviter with the invitee to verify their identity. This is not sent in the invitation. The inviter should share this string with the invitee though another channel.", + "generatedName": "JointOwnerInvitationFieldsSharedSecret", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 100, + "minLength": 8, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "jointOwnerInvitationFieldsEmailAddress", + "key": "emailAddress", + "schema": { + "description": "The invitee's email address.", + "generatedName": "JointOwnerInvitationFieldsEmailAddress", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 80, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "jointOwnerInvitationFieldsDisallowDebitCardAccess", + "key": "disallowDebitCardAccess", + "schema": { + "description": null, + "generatedName": "jointOwnerInvitationFieldsDisallowDebitCardAccess", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "If \`true\`, the invitee is not allowed to order or manage debit cards for the account.", + "generatedName": "JointOwnerInvitationFieldsDisallowDebitCardAccess", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "maskedAccountNumber": { + "description": "A masked account number: an asterisk \`*\` followed by one to four characters of the \`fullAccountNumber\`.", + "generatedName": "MaskedAccountNumber", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 5, + "minLength": 2, + "type": "string", + }, + "type": "primitive", + }, + "monetaryValue": { + "description": "The monetary value, supporting only positive amounts. The numeric value is represented as a string so that it can be exact with no loss of precision.
The schema \`monetaryValue\` was added on version \`0.4.0\` of the API.", + "generatedName": "MonetaryValue", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + "newJointOwnerInvitation": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "JointOwnerInvitationFields", + "groupName": null, + "nameOverride": null, + "schema": "jointOwnerInvitationFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "A request to create an invitation to add a new joint owner to an account.", + "generatedName": "NewJointOwnerInvitation", + "groupName": null, + "nameOverride": null, + "properties": [], + "type": "object", + }, + "newTransfer": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "TransferFields", + "groupName": null, + "nameOverride": null, + "schema": "transferFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "Representation used to create a new transfer.", + "generatedName": "NewTransfer", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "newTransferSchedule", + "key": "schedule", + "schema": { + "description": null, + "generatedName": "newTransferSchedule", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "When the transfer should occur and any recurrence.", + "generatedName": "NewTransferSchedule", + "groupName": null, + "nameOverride": null, + "schema": "transferSchedule", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "overdraftAccountFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Fields of an overdraft protection account, used to compose other schemas.", + "generatedName": "OverdraftAccountFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "overdraftAccountFieldsId", + "key": "id", + "schema": { + "description": null, + "generatedName": "overdraftAccountFieldsId", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The unique ID of the account resource. Use this as the \`{accountId}\` in [\`getAccount\`](#op-getAccount) or [\`listAccountBalances\`](#op-listAccountBalances).", + "generatedName": "OverdraftAccountFieldsId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "overdraftAccountFieldsLabel", + "key": "label", + "schema": { + "description": null, + "generatedName": "overdraftAccountFieldsLabel", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", + "generatedName": "OverdraftAccountFieldsLabel", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 80, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "overdraftAccountFieldsMaskedNumber", + "key": "maskedNumber", + "schema": { + "description": null, + "generatedName": "overdraftAccountFieldsMaskedNumber", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "OverdraftAccountFieldsMaskedNumber", + "groupName": null, + "nameOverride": null, + "schema": "maskedAccountNumber", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "overdraftAccountItem": { + "description": "An overdraft protection account linked to another protected account. The \`label\` and \`maskedNumber\` are informational only.", + "generatedName": "OverdraftAccountItem", + "groupName": null, + "nameOverride": null, + "schema": "overdraftAccountFields", + "type": "reference", + }, + "overdraftProtection": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "OverdraftProtectionFields", + "groupName": null, + "nameOverride": null, + "schema": "overdraftProtectionFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "Representation of the overdraft protection settings, consisting of a list of overdraft protection accounts linked to the account identified by the \`{accountId}\`.", + "generatedName": "OverdraftProtection", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "overdraftProtectionMaximumOverdraftAccounts", + "key": "maximumOverdraftAccounts", + "schema": { + "description": "The maximum number of overdraft protection accounts that may be linked to the account.", + "generatedName": "OverdraftProtectionMaximumOverdraftAccounts", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "overdraftProtectionFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Fields used to compose other overdraft protection schemas.", + "generatedName": "OverdraftProtectionFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "overdraftProtectionFieldsAccounts", + "key": "accounts", + "schema": { + "description": null, + "generatedName": "overdraftProtectionFieldsAccounts", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "generatedName": "OverdraftProtectionFieldsAccounts", + "nameOverride": null, + "type": "unknown", + }, + }, + }, + ], + "type": "object", + }, + "overdraftProtectionPatch": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "OverdraftProtectionFields", + "groupName": null, + "nameOverride": null, + "schema": "overdraftProtectionFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "Representation of request used to patch the overdraft protection settings consisting of a list of overdraft protection accounts linked to the account identified by the \`{accountId}\`.", + "generatedName": "OverdraftProtectionPatch", + "groupName": null, + "nameOverride": null, + "properties": [], + "type": "object", + }, + "positiveIntegerRange": { + "description": "A positive integer range, supporting inclusive or exclusive endpoints. The value may have the following forms: ", + "generatedName": "PositiveIntegerRange", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + "problemResponse": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "ApiProblem", + "groupName": null, + "nameOverride": null, + "schema": "apiProblem", + }, + ], + "allOfPropertyConflicts": [], + "description": "API problem or error response, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).", + "generatedName": "ProblemResponse", + "groupName": null, + "nameOverride": null, + "properties": [], + "type": "object", + }, + "productReference": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "A reference to a banking product.", + "generatedName": "ProductReference", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "productReferenceType", + "key": "type", + "schema": { + "description": "The type of account.", + "generatedName": "ProductReferenceType", + "groupName": null, + "nameOverride": null, + "schema": "productType", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "productReferenceCode", + "key": "code", + "schema": { + "description": "The product's product code. Codes are unique to the financial institution.", + "generatedName": "ProductReferenceCode", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 16, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "productReferenceLabel", + "key": "label", + "schema": { + "description": "A human-readable label for this banking product.", + "generatedName": "ProductReferenceLabel", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 48, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "productReferenceDescription", + "key": "description", + "schema": { + "description": "A human-readable description of this banking product.", + "generatedName": "ProductReferenceDescription", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 400, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "productType": { + "description": "The type (or category) of bank account. + +productType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
savingsSavings:

Savings Account

+
checkingChecking:

Checking Account

+
cdCD:

Certificate of Deposit Account

+
iraIRA:

Individual Retirement Account

+
loanLoan:

Loan Account

+
creditCardCredit Card:

Credit Card Account

+
+ +", + "generatedName": "ProductType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "savings", + "nameOverride": null, + "value": "savings", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "checking", + "nameOverride": null, + "value": "checking", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "cd", + "nameOverride": null, + "value": "cd", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "ira", + "nameOverride": null, + "value": "ira", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "loan", + "nameOverride": null, + "value": "loan", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "creditCard", + "nameOverride": null, + "value": "creditCard", + }, + ], + }, + "readOnlyResourceId": { + "description": "The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.", + "generatedName": "ReadOnlyResourceId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + "readOnlyTimestamp": { + "description": "A readonly or derived timestamp (an instant in time) formatted in [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date-time\` UTC format: \`YYYY-MM-DDThh:mm:ss.sssZ\`.
The schema \`readOnlyTimestamp\` was added on version \`0.4.0\` of the API.", + "generatedName": "ReadOnlyTimestamp", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "datetime", + }, + "type": "primitive", + }, + "requiredIdentityChallenge": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 [Unauthorized problem response](#schema-apiProblem) when the 401 problem type name is \`challengeRequired\`. See the "Challenge API" for details.", + "generatedName": "RequiredIdentityChallenge", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "requiredIdentityChallengeXFernSdkMethodName", + "key": "x-fern-sdk-method-name", + "schema": { + "description": "The ID of the API operation for which the user must verify their identity. This is passed when starting a challenge factor or when validating the identity challenge responses.", + "generatedName": "RequiredIdentityChallengeXFernSdkMethodName", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "requiredIdentityChallengeChallengeId", + "key": "challengeId", + "schema": { + "description": "The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses.", + "generatedName": "RequiredIdentityChallengeChallengeId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "requiredIdentityChallengeFactors", + "key": "factors", + "schema": { + "description": "A list of challenge factors. The user must complete one of these challenge factors. The \`labels\` in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. ***Note**: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an \`sms\` factor and a \`voice\` factor.", + "generatedName": "RequiredIdentityChallengeFactors", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "RequiredIdentityChallengeFactorsItem", + "groupName": null, + "nameOverride": null, + "schema": "challengeFactor", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "resourceId": { + "description": "The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.", + "generatedName": "ResourceId", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 48, + "minLength": 6, + "type": "string", + }, + "type": "primitive", + }, + "simpleInstitution": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "A simple representation of a financial institution.", + "generatedName": "SimpleInstitution", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "simpleInstitutionName", + "key": "name", + "schema": { + "description": "The financial institution's name.", + "generatedName": "SimpleInstitutionName", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 35, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "simpleInstitutionAddress", + "key": "address", + "schema": { + "description": "The financial institution's postal mailing address.", + "generatedName": "SimpleInstitutionAddress", + "groupName": null, + "nameOverride": null, + "schema": "address", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "simpleInstitutionLocator", + "key": "locator", + "schema": { + "description": "The [American Bankers Association routing number](https://www.aba.com/about-us/routingnumber), [SWIFT Business Identifier Code (BIC) code](https://www.swift.com/standards/data-standards/bic-business-identifier-code), or [IBAN account number](https://www.ecbs.org/iban.htm) of the institution. The form of this institution locator string is set with the \`locatorType\` property.", + "generatedName": "SimpleInstitutionLocator", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 36, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "simpleInstitutionLocatorType", + "key": "locatorType", + "schema": { + "description": "Indicates the type of this institution's \`locator\`.", + "generatedName": "SimpleInstitutionLocatorType", + "groupName": null, + "nameOverride": null, + "schema": "institutionLocatorType", + "type": "reference", + }, + }, + ], + "type": "object", + }, + "timeZoneId": { + "description": "The identifier of a time zone, as described by [RFC 7808](https://datatracker.ietf.org/doc/html/rfc7808.html#section-3.6). This value corresponds with the \`tzid\` value described in [RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.2.19) and defined by the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "generatedName": "TimeZoneId", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 36, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + "timestampFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Timestamps which describe when a resource was created or last updated.", + "generatedName": "TimestampFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "timestampFieldsCreatedAt", + "key": "createdAt", + "schema": { + "description": null, + "generatedName": "timestampFieldsCreatedAt", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC. This is derived and immutable.", + "generatedName": "TimestampFieldsCreatedAt", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "datetime", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "timestampFieldsUpdatedAt", + "key": "updatedAt", + "schema": { + "description": null, + "generatedName": "timestampFieldsUpdatedAt", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date-time when the resource was last updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time \`YYYY-MM-DDThh:mm:ss.sssZ\` format, UTC. This is derived and immutable.", + "generatedName": "TimestampFieldsUpdatedAt", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "datetime", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transactionCategories": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": null, + "generatedName": "TransactionCategories", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionCategoriesItems", + "key": "items", + "schema": { + "description": "An array containing transaction category items.", + "generatedName": "TransactionCategoriesItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransactionCategoriesItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "transactionCategory", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "transactionCategorization": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "The transaction categorization.", + "generatedName": "TransactionCategorization", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionCategorizationLabel", + "key": "label", + "schema": { + "description": null, + "generatedName": "TransactionCategorizationLabel", + "groupName": null, + "nameOverride": null, + "schema": "transactionCategoryLabel", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionCategorizationId", + "key": "id", + "schema": { + "description": "The unique ID of this transaction's category.", + "generatedName": "TransactionCategorizationId", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 32, + "minLength": 1, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "transactionCategory": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "TransactionCategorization", + "groupName": null, + "nameOverride": null, + "schema": "transactionCategorization", + }, + ], + "allOfPropertyConflicts": [], + "description": "Representation of transaction category resources.", + "generatedName": "TransactionCategory", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionCategoryType", + "key": "type", + "schema": { + "description": null, + "generatedName": "TransactionCategoryType", + "groupName": null, + "nameOverride": null, + "schema": "transactionCategoryType", + "type": "reference", + }, + }, + ], + "type": "object", + }, + "transactionCategoryLabel": { + "description": "The label of a transaction category, such as \`"Shopping"\`, \`"Deposit"\`, \`"Bill"\`, \`"Transfer"\`, or \`"Other"\`.", + "generatedName": "TransactionCategoryLabel", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 64, + "minLength": 1, + "type": "string", + }, + "type": "primitive", + }, + "transactionCategoryType": { + "description": "Classifies a transaction category as applying to either debit or credit transactions. + +transactionCategoryType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + +
ValueDescription
creditCredit:

This transaction category applies to credit (expense) transactions.

+
debitDebit:

This transaction category applies to debit (income) transactions.

+
+ +", + "generatedName": "TransactionCategoryType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "credit", + "nameOverride": null, + "value": "credit", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "debit", + "nameOverride": null, + "value": "debit", + }, + ], + }, + "transactionCheck": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Describes a check associated with a transaction for a checking account. This object is only present if the transaction \`type\` is \`debit\` and the \`subtype\` is \`check\`.", + "generatedName": "TransactionCheck", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionCheckNumber", + "key": "number", + "schema": { + "description": "The check number.", + "generatedName": "TransactionCheckNumber", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionCheckImageFrontUrl", + "key": "imageFront_url", + "schema": { + "description": null, + "generatedName": "transactionCheckImageFrontUrl", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The URL for downloading the image of the front of the check.", + "generatedName": "TransactionCheckImageFrontUrl", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 400, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionCheckImageBackUrl", + "key": "imageBack_url", + "schema": { + "description": null, + "generatedName": "transactionCheckImageBackUrl", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The URL for downloading the image of the front of the check.", + "generatedName": "TransactionCheckImageBackUrl", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 400, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transactionFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Common fields of the transaction resource used to build other model schemas.", + "generatedName": "TransactionFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsId", + "key": "id", + "schema": { + "description": "This transaction's unique identifier.", + "generatedName": "TransactionFieldsId", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 128, + "minLength": 6, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsType", + "key": "type", + "schema": { + "description": "The transaction type. If the \`type\` is \`debit\` or \`credit\`, the \`subtype\` conveys further transaction type details.", + "generatedName": "TransactionFieldsType", + "groupName": null, + "nameOverride": null, + "schema": "transactionType", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsSubtype", + "key": "subtype", + "schema": { + "description": "The transaction's kind of debit or credit.", + "generatedName": "TransactionFieldsSubtype", + "groupName": null, + "nameOverride": null, + "schema": "transactionSubType", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsOccurredOn", + "key": "occurredOn", + "schema": { + "description": "The date of the transaction in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format. This is derived and immutable.", + "generatedName": "TransactionFieldsOccurredOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsCreatedOn", + "key": "createdOn", + "schema": { + "description": null, + "generatedName": "transactionFieldsCreatedOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date when the transaction occurred in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format. This is derived and immutable.
**Warning**: The property \`createdOn\` was deprecated on version \`v2.1.0\` of the schema. Use the \`occurredOn\` property instead. \`createdOn\` will be removed on version \`v3.0.0\` of the schema.", + "generatedName": "TransactionFieldsCreatedOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsPostedOn", + "key": "postedOn", + "schema": { + "description": null, + "generatedName": "transactionFieldsPostedOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date when this transaction was posted (cleared and applied to the account balance) in [RFC 3339](https://tools.ietf.org/html/rfc3339) date \`YYYY-MM-DD\` format, UTC. This is derived and immutable and only present if \`posted\` is \`true\`.
**Warning**: The property \`postedOn\` was deprecated on version \`v2.1.0\` of the schema. Use the \`occurredOn\` property instead. \`postedOn\` will be removed on version \`v3.0.0\` of the schema.", + "generatedName": "TransactionFieldsPostedOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsAmount", + "key": "amount", + "schema": { + "description": "The transaction amount in dollars. This value is negative if the transaction is a debit and positive if it is a credit.", + "generatedName": "TransactionFieldsAmount", + "groupName": null, + "nameOverride": null, + "schema": "creditOrDebitValue", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsPosted", + "key": "posted", + "schema": { + "description": null, + "generatedName": "transactionFieldsPosted", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "If \`true\`, the transaction has been posted (cleared) and applied to the account. If \`false\`, the transaction is still pending and might be canceled. \`posted\` is only valid for credit and debit transactions and omitted for balance transactions.", + "generatedName": "TransactionFieldsPosted", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "boolean", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsBalance", + "key": "balance", + "schema": { + "description": null, + "generatedName": "transactionFieldsBalance", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The account's running current balance as of this transaction. The \`balance\` may be omitted if the request includes filters which preclude the inclusion of a running balance.", + "generatedName": "TransactionFieldsBalance", + "groupName": null, + "nameOverride": null, + "schema": "creditOrDebitValue", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsMemo", + "key": "memo", + "schema": { + "description": null, + "generatedName": "transactionFieldsMemo", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The user-settable transaction memo.", + "generatedName": "TransactionFieldsMemo", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 128, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsDescription", + "key": "description", + "schema": { + "description": null, + "generatedName": "transactionFieldsDescription", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The transaction description assigned by the transaction cleansing service.", + "generatedName": "TransactionFieldsDescription", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 128, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsCategory", + "key": "category", + "schema": { + "description": null, + "generatedName": "transactionFieldsCategory", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The transaction category, if assigned.", + "generatedName": "TransactionFieldsCategory", + "groupName": null, + "nameOverride": null, + "schema": "transactionCategorization", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsMerchant", + "key": "merchant", + "schema": { + "description": null, + "generatedName": "transactionFieldsMerchant", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "TransactionFieldsMerchant", + "groupName": null, + "nameOverride": null, + "schema": "transactionMerchant", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionFieldsCheck", + "key": "check", + "schema": { + "description": null, + "generatedName": "transactionFieldsCheck", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "TransactionFieldsCheck", + "groupName": null, + "nameOverride": null, + "schema": "transactionCheck", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "transactionItem": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "TransactionFields", + "groupName": null, + "nameOverride": null, + "schema": "transactionFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "Summary representation of a transaction resource in transactions collections.", + "generatedName": "TransactionItem", + "groupName": null, + "nameOverride": null, + "properties": [], + "type": "object", + }, + "transactionMerchant": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Describes the merchant associated with a transaction.", + "generatedName": "TransactionMerchant", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionMerchantName", + "key": "name", + "schema": { + "description": null, + "generatedName": "transactionMerchantName", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The merchant\\'s name.", + "generatedName": "TransactionMerchantName", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 32, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionMerchantWebsiteUrl", + "key": "website_url", + "schema": { + "description": null, + "generatedName": "transactionMerchantWebsiteUrl", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The merchant's website URL.", + "generatedName": "TransactionMerchantWebsiteUrl", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 400, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionMerchantLogoUrl", + "key": "logo_url", + "schema": { + "description": null, + "generatedName": "transactionMerchantLogoUrl", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The optional URL of the merchant's logo. This image must be an image resource (SVG, PNG, GIF, JPEG image) that does not require any authentication. The URL may contain query parameters.", + "generatedName": "TransactionMerchantLogoUrl", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 400, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transactionSubType": { + "description": "If the type is \`debit\` or \`credit\`, the subtype conveys further transaction type details. + +transactionSubType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + +
ValueDescription
checkCheck:

A check drawn from a checking account.

+
otherOther:

Some other transaction type.

+
+ +", + "generatedName": "TransactionSubType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "check", + "nameOverride": null, + "value": "check", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "other", + "nameOverride": null, + "value": "other", + }, + ], + }, + "transactionType": { + "description": "Distinguishes between balance, debit, or credit transactions. + +transactionType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + +
ValueDescription
balanceBalance:

A pseudo-transaction that conveys the account balance.

+
debitDebit:

A debit against the account.

+
creditCredit:

A credit transaction.

+
+ +", + "generatedName": "TransactionType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "balance", + "nameOverride": null, + "value": "balance", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "debit", + "nameOverride": null, + "value": "debit", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "credit", + "nameOverride": null, + "value": "credit", + }, + ], + }, + "transactions": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractPagedBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractPagedBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "Collection of transactions. The items in the collection are ordered in the \`items\` array. The response object may contain the \`nextPage_url\` pagination link.", + "generatedName": "Transactions", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionsItems", + "key": "items", + "schema": { + "description": null, + "generatedName": "transactionsItems", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "An array containing a page of transaction items.", + "generatedName": "TransactionsItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransactionsItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "transactionItem", + "type": "reference", + }, + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transactionsCount", + "key": "count", + "schema": { + "description": null, + "generatedName": "transactionsCount", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The total number of transactions which satisfy the request filters. This is optional and only included if the service can calculate it.", + "generatedName": "TransactionsCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transfer": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "TransferItem", + "groupName": null, + "nameOverride": null, + "schema": "transferItem", + }, + ], + "allOfPropertyConflicts": [], + "description": "Representation of a transfer resource.", + "generatedName": "Transfer", + "groupName": null, + "nameOverride": null, + "properties": [], + "type": "object", + }, + "transferAccountReference": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "A reference to a banking account used within an account to account transfer. This object may be set from an account's \`account.reference\` object.", + "generatedName": "TransferAccountReference", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferAccountReferenceId", + "key": "id", + "schema": { + "description": "The unique ID of a banking account.", + "generatedName": "TransferAccountReferenceId", + "groupName": null, + "nameOverride": null, + "schema": "resourceId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferAccountReferenceLabel", + "key": "label", + "schema": { + "description": null, + "generatedName": "transferAccountReferenceLabel", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The human-readable label for this account. This is either the \`nickname\` (if assigned for the current customer), or the \`product.label\` concatenated with the \`maskedNumber\`.", + "generatedName": "TransferAccountReferenceLabel", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 80, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferAccountReferenceType", + "key": "type", + "schema": { + "description": null, + "generatedName": "transferAccountReferenceType", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The product type of the account.", + "generatedName": "TransferAccountReferenceType", + "groupName": null, + "nameOverride": null, + "schema": "productType", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferAccountReferenceLocation", + "key": "location", + "schema": { + "description": null, + "generatedName": "transferAccountReferenceLocation", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "Indicates where an account is held.", + "generatedName": "TransferAccountReferenceLocation", + "groupName": null, + "nameOverride": null, + "schema": "accountLocation", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "transferDateRestriction": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "A date where a transfer restriction occurs, and the \`reason\` it is restricted. If the \`reason\` is \`holiday\`, \`closure\` and the transfer is an ACH transfer, the object also contains either a \`debitOn\` or \`creditOn\` date or both.", + "generatedName": "TransferDateRestriction", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferDateRestrictionOccursOn", + "key": "occursOn", + "schema": { + "description": "The date that a transfers restriction occurs, is in the [ISO 8601 Date](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates) format, \`yyyy-mm-dd\`.", + "generatedName": "TransferDateRestrictionOccursOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferDateRestrictionReason", + "key": "reason", + "schema": { + "description": "Indicates why this date is restricted.", + "generatedName": "TransferDateRestrictionReason", + "groupName": null, + "nameOverride": null, + "schema": "transferDateRestrictionType", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferDateRestrictionCreditOn", + "key": "creditOn", + "schema": { + "description": null, + "generatedName": "transferDateRestrictionCreditOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date the local financial institution account is credited in [RFC 3339 \`YYYY-MM-DD\`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the \`date\` based on the \`risk\` level. The credit-on date normally falls one business day after the restricted \`date\`. This property is only returned if the payment \`type\` is \`achDebit\` or \`ach\`.", + "generatedName": "TransferDateRestrictionCreditOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferDateRestrictionDebitOn", + "key": "debitOn", + "schema": { + "description": null, + "generatedName": "transferDateRestrictionDebitOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date the local financial institution account is debited in [RFC 3339 \`YYYY-MM-DD\`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the \`date\` based on the \`risk\` level and the transfer direction (\`achDebit\` or \`achCredit\`). The debit-on date normally falls one to three business days before the restricted \`date\`. This property is only returned if the payment \`type\` is \`achCredit\` or \`ach\`.", + "generatedName": "TransferDateRestrictionDebitOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transferDateRestrictionType": { + "description": "Indicates why a transfer date is restricted. + +transferDateRestrictionType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
pastDatePast Date:

The transfer date is in the past

+
pastCutoffTimePast Cutoff Time:

Transfers disallowed because the current time is past the financial institutions' cutoff time

+
riskRestrictedRisk Restricted:

The date is restricted because the risk level requires one or more days for a debit to clear

+
holidayHoliday:

A Federal Reserve System observed holiday

+
closureClosure:

Financial institution closure, such as a weekend or other planned closure

+
otherOther:

Other

+
+ +", + "generatedName": "TransferDateRestrictionType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "pastDate", + "nameOverride": null, + "value": "pastDate", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "pastCutoffTime", + "nameOverride": null, + "value": "pastCutoffTime", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "riskRestricted", + "nameOverride": null, + "value": "riskRestricted", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "holiday", + "nameOverride": null, + "value": "holiday", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "closure", + "nameOverride": null, + "value": "closure", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "other", + "nameOverride": null, + "value": "other", + }, + ], + }, + "transferDateRestrictions": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "A list of the financial institution's transfer date restrictions. This is a list of weekdays and specific dates when the institution cannot perform the requested transfers. +The response may include dates prior to requested the start date, as that is useful for populating a calendar that shows the current month and the last few days of the previous month.", + "generatedName": "TransferDateRestrictions", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferDateRestrictionsRestrictedDates", + "key": "restrictedDates", + "schema": { + "description": null, + "generatedName": "transferDateRestrictionsRestrictedDates", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "A list of restricted transfer dates as determined by the requested transfer parameters, holidays, and scheduled closures. This includes dates that correspond to normal day-of-week restrictions as listed in \`restrictedDays\`.", + "generatedName": "TransferDateRestrictionsRestrictedDates", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransferDateRestrictionsRestrictedDatesItem", + "groupName": null, + "nameOverride": null, + "schema": "transferDateRestriction", + "type": "reference", + }, + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferDateRestrictionsAccuracyEndsOn", + "key": "accuracyEndsOn", + "schema": { + "description": null, + "generatedName": "transferDateRestrictionsAccuracyEndsOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The service only knows [bank holidays](https://www.federalreserve.gov/aboutthefed/k8.htm) for about two to four years in advance. This date is the end of that known holiday schedule, although the requested dates may extend well beyond this date. Any dates in the response beyond this date may omit holidays but may include other restricted dates based on the financial institution's normal scheduled closures such as Saturdays and Sundays.", + "generatedName": "TransferDateRestrictionsAccuracyEndsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transferFields": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Common fields of the transfer resource used to build other model schemas.", + "generatedName": "TransferFields", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferFieldsAmount", + "key": "amount", + "schema": { + "description": null, + "generatedName": "transferFieldsAmount", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The amount of money to transfer between accounts.", + "generatedName": "TransferFieldsAmount", + "groupName": null, + "nameOverride": null, + "schema": "monetaryValue", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferFieldsSourceAccount", + "key": "sourceAccount", + "schema": { + "description": null, + "generatedName": "transferFieldsSourceAccount", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The source account where the funds are withdrawn.", + "generatedName": "TransferFieldsSourceAccount", + "groupName": null, + "nameOverride": null, + "schema": "transferAccountReference", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferFieldsTargetAccount", + "key": "targetAccount", + "schema": { + "description": null, + "generatedName": "transferFieldsTargetAccount", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The target account where the funds are deposited.", + "generatedName": "TransferFieldsTargetAccount", + "groupName": null, + "nameOverride": null, + "schema": "transferAccountReference", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferFieldsMemo", + "key": "memo", + "schema": { + "description": null, + "generatedName": "transferFieldsMemo", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "A customer-defined memo to describe the transfer.", + "generatedName": "TransferFieldsMemo", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 128, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transferFrequency": { + "description": "For recurring transfers, the interval at which the money movement recurs. + +transferFrequency strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
onceOnce:

Transfer does not repeat

+
occasionalOccasional:

Transfer recurs but without a new scheduled date

+
dailyDaily:

Repeat daily on business days

+
weeklyWeekly:

Repeat weekly

+
biweeklybiweekly:

Repeat every two weeks (26 times a year)

+
semimonthlySemimonthly:

Repeat twice a month (24 times a year)

+
monthlyMonthly:

Repeat monthly

+
monthlyFirstDayMonthly First Day:

Repeat on the first business day of the month

+
monthlyLastDayMonthly Last Day:

Repeat on the last business day of the month

+
bimonthlyBimonthly:

Repeat every other month

+
quarterlyQuarterly:

Repeat quarterly (four times a year)

+
semiyearlySemiyearly:

Repeat every six months (twice a year)

+
yearlyYearly:

Repeat once every year

+
+ +", + "generatedName": "TransferFrequency", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "once", + "nameOverride": null, + "value": "once", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "occasional", + "nameOverride": null, + "value": "occasional", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "daily", + "nameOverride": null, + "value": "daily", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "weekly", + "nameOverride": null, + "value": "weekly", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "biweekly", + "nameOverride": null, + "value": "biweekly", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "semimonthly", + "nameOverride": null, + "value": "semimonthly", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "monthly", + "nameOverride": null, + "value": "monthly", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "monthlyFirstDay", + "nameOverride": null, + "value": "monthlyFirstDay", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "monthlyLastDay", + "nameOverride": null, + "value": "monthlyLastDay", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "bimonthly", + "nameOverride": null, + "value": "bimonthly", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "quarterly", + "nameOverride": null, + "value": "quarterly", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "semiyearly", + "nameOverride": null, + "value": "semiyearly", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "yearly", + "nameOverride": null, + "value": "yearly", + }, + ], + }, + "transferItem": { + "allOf": [ + { + "description": null, + "generatedName": "TransferFields", + "groupName": null, + "nameOverride": null, + "schema": "transferFields", + }, + { + "description": null, + "generatedName": "TimestampFields", + "groupName": null, + "nameOverride": null, + "schema": "timestampFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "Summary representation of a transfer resource in transfers collections. To fetch the full representation of this transfer, use the [\`getTransfer\`](#op-getTransfer) operation, passing this item's \`id\` field as the \`transferId\` path parameter.", + "generatedName": "TransferItem", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferItemId", + "key": "id", + "schema": { + "description": "The unique identifier for this transfer resource. This is an immutable opaque string.", + "generatedName": "TransferItemId", + "groupName": null, + "nameOverride": null, + "schema": "readOnlyResourceId", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferItemSchedule", + "key": "schedule", + "schema": { + "description": "When the transfer should occur and any recurrence.", + "generatedName": "TransferItemSchedule", + "groupName": null, + "nameOverride": null, + "schema": "transferItemSchedule", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferItemState", + "key": "state", + "schema": { + "description": "The state of this transfer resource.", + "generatedName": "TransferItemState", + "groupName": null, + "nameOverride": null, + "schema": "transferState", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferItemProcessedAt", + "key": "processedAt", + "schema": { + "description": null, + "generatedName": "transferItemProcessedAt", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date/time the transfer was processed.", + "generatedName": "TransferItemProcessedAt", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "datetime", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferItemUpdatedBy", + "key": "updatedBy", + "schema": { + "description": null, + "generatedName": "transferItemUpdatedBy", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The full name of the banking customer who last updated the transfer.", + "generatedName": "TransferItemUpdatedBy", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 48, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transferItemSchedule": { + "allOf": [ + { + "description": null, + "generatedName": "TransferSchedule", + "groupName": null, + "nameOverride": null, + "schema": "transferSchedule", + }, + ], + "allOfPropertyConflicts": [], + "description": "A transfer's schedule: when the transfer is scheduled, its recurrence properties, and derived credit and debit dates.", + "generatedName": "TransferItemSchedule", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferItemScheduleDebitsOn", + "key": "debitsOn", + "schema": { + "description": null, + "generatedName": "transferItemScheduleDebitsOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The effective date the transfer is scheduled to debit the source account, in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format. This is derived from the \`scheduledOn\` date, based on the financial institution's transfer rules.", + "generatedName": "TransferItemScheduleDebitsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferItemScheduleCreditsOn", + "key": "creditsOn", + "schema": { + "description": null, + "generatedName": "transferItemScheduleCreditsOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The effective the transfer is scheduled to credit the target account, in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format. This is derived from the \`scheduledOn\` date, based on the financial institution's transfer rules.", + "generatedName": "TransferItemScheduleCreditsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "transferPatch": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + { + "description": null, + "generatedName": "TransferFields", + "groupName": null, + "nameOverride": null, + "schema": "transferFields", + }, + ], + "allOfPropertyConflicts": [], + "description": "Representation used to patch an existing transfer using the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7396) format and processing rules.", + "generatedName": "TransferPatch", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferPatchSchedule", + "key": "schedule", + "schema": { + "description": null, + "generatedName": "transferPatchSchedule", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "When the transfer should occur and any recurrence.", + "generatedName": "TransferPatchSchedule", + "groupName": null, + "nameOverride": null, + "schema": "transferSchedule", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "transferRecurrenceType": { + "description": "Describes whether the transfer amount in the transfer varies or is fixed when the transfer recurs. This is ignored if the transfer frequency is \`once\`. + +transferRecurrenceType strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + +
ValueDescription
fixedFixed:

The transfer amounts are the same each time a transfer recurs

+
variableVariable:

The transfer amounts vary and must be entered/verified each time a transfer recurs

+
+ +", + "generatedName": "TransferRecurrenceType", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "fixed", + "nameOverride": null, + "value": "fixed", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "variable", + "nameOverride": null, + "value": "variable", + }, + ], + }, + "transferSchedule": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "The scheduled date when the transfer should be completed, the recurrence, if any, and other derived dates based on the scheduled date. + +For recurring transfer schedules, \`endsOn\`, \`count\`, and \`amountLimit\` are mutually exclusive.", + "generatedName": "TransferSchedule", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleScheduledOn", + "key": "scheduledOn", + "schema": { + "description": null, + "generatedName": "transferScheduleScheduledOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The date the the customer scheduled the transfer to occur in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) \`date\` format.", + "generatedName": "TransferScheduleScheduledOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleRecurrenceType", + "key": "recurrenceType", + "schema": { + "description": null, + "generatedName": "transferScheduleRecurrenceType", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": null, + "generatedName": "TransferScheduleRecurrenceType", + "groupName": null, + "nameOverride": null, + "schema": "transferRecurrenceType", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleFrequency", + "key": "frequency", + "schema": { + "description": null, + "generatedName": "TransferScheduleFrequency", + "groupName": null, + "nameOverride": null, + "schema": "transferFrequency", + "type": "reference", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleEndsOn", + "key": "endsOn", + "schema": { + "description": null, + "generatedName": "transferScheduleEndsOn", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The optional date when the recurring transfer schedule ends, in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. Subsequent recurring transfers may be scheduled up to and including this date, but not after. This property is ignored if \`frequency\` is \`once\`.", + "generatedName": "TransferScheduleEndsOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleCount", + "key": "count", + "schema": { + "description": null, + "generatedName": "transferScheduleCount", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "For recurring schedules (\`frequency\` is not \`once\`), this is the total number of transfers to make, including the first transfer. This property is ignored if \`frequency\` is \`once\`.", + "generatedName": "TransferScheduleCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleAmountLimit", + "key": "amountLimit", + "schema": { + "description": null, + "generatedName": "transferScheduleAmountLimit", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "For recurring schedules (\`frequency\` is not \`once\`), this is the total dollar amount limit including the first transfer. No transfers are scheduled if they would exceed this amount. This property is ignored if \`frequency\` is \`once\`.", + "generatedName": "TransferScheduleAmountLimit", + "groupName": null, + "nameOverride": null, + "schema": "monetaryValue", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "transferScheduleDirection": { + "description": "Provides the direction in which a transfer flows. + +transferScheduleDirection strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + +
ValueDescription
debitDebit:

Money is transferred from a payer to the financial institution

+
creditCredit:

Money is transferred from the financial institution to a payee

+
bothBoth:

Money is transferred both to and from a payee/payer

+
+ +", + "generatedName": "TransferScheduleDirection", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "debit", + "nameOverride": null, + "value": "debit", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "credit", + "nameOverride": null, + "value": "credit", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "both", + "nameOverride": null, + "value": "both", + }, + ], + }, + "transferScheduleItem": { + "allOf": [], + "allOfPropertyConflicts": [], + "description": "Summary representation of a transfer schedule resource in transfer schedule list.", + "generatedName": "TransferScheduleItem", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleItemScheduledOn", + "key": "scheduledOn", + "schema": { + "description": "The scheduled date of the calculated calendar recurrence in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format.", + "generatedName": "TransferScheduleItemScheduledOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transferScheduleItemEffectiveOn", + "key": "effectiveOn", + "schema": { + "description": "The effective date of the recurrence in \`YYYY-MM-DD\` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. When the effective date differs from the scheduled date, it is due to a banking holiday, weekend, or other non-business day. The date is adjusted to before the scheduled date when the transfer direction is \`credit\` and adjusted to after the scheduled date when the transfer direction is \`debit\`.", + "generatedName": "TransferScheduleItemEffectiveOn", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": null, + "minLength": null, + "type": "string", + }, + "type": "primitive", + }, + }, + ], + "type": "object", + }, + "transferSchedules": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "List of transfer methods. The items in the list are ordered in the \`items\` array.", + "generatedName": "TransferSchedules", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transferSchedulesItems", + "key": "items", + "schema": { + "description": "An array containing upcoming transfer schedule items.", + "generatedName": "TransferSchedulesItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransferSchedulesItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "transferScheduleItem", + "type": "reference", + }, + }, + }, + ], + "type": "object", + }, + "transferState": { + "description": "The state of a transfer resource. + +transferState strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
unscheduledUnscheduled:

A transfer which is not ready to be queued for processing

+
pendingApprovalPending Approval:

A transfer which is awaiting approval before it can be queued for processing

+
scheduledScheduled:

A transfer which has been queued for processing

+
processingProcessing:

A transfer which is being processed

+
processedProcessed:

A transfer which has completed processing

+
failedFailed:

A transfer which has cannot be processed or failed while processing

+
otherOther:

A transfer which is in some other state

+
+ +", + "generatedName": "TransferState", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "unscheduled", + "nameOverride": null, + "value": "unscheduled", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "pendingApproval", + "nameOverride": null, + "value": "pendingApproval", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "scheduled", + "nameOverride": null, + "value": "scheduled", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "processing", + "nameOverride": null, + "value": "processing", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "processed", + "nameOverride": null, + "value": "processed", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "failed", + "nameOverride": null, + "value": "failed", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "other", + "nameOverride": null, + "value": "other", + }, + ], + }, + "transferTypeForDateRestrictions": { + "description": "Indicates the type of transfer. This determines what business rules and adjustments to make to the date restrictions. + +transferTypeForDateRestrictions strings may have one of the following +[enumerated values](https://dx.apiture.com/docs/api-documentation/concepts/label-groups#enumerations): + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
internalInternal:

Internal account to internal account transfer

+
achACH:

An ACH transfer that includes both debit and credit transfers

+
achCreditACH Credit:

An ACH transfer debiting an internal account and crediting an external account

+
achDebitACH Debit:

An ACH transfer debiting an external account and crediting an internal account

+
domesticWireTransferDomestic Wire Transfer
internationalWireTransferInternational Wire Transfer
+ +", + "generatedName": "TransferTypeForDateRestrictions", + "groupName": null, + "nameOverride": null, + "type": "enum", + "values": [ + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "internal", + "nameOverride": null, + "value": "internal", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "ach", + "nameOverride": null, + "value": "ach", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "achDebit", + "nameOverride": null, + "value": "achDebit", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "achCredit", + "nameOverride": null, + "value": "achCredit", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "domesticWireTransfer", + "nameOverride": null, + "value": "domesticWireTransfer", + }, + { + "casing": { + "camel": null, + "pascal": null, + "screamingSnake": null, + "snake": null, + }, + "description": null, + "generatedName": "internationalWireTransfer", + "nameOverride": null, + "value": "internationalWireTransfer", + }, + ], + }, + "transfers": { + "allOf": [ + { + "description": null, + "generatedName": "AbstractPagedBody", + "groupName": null, + "nameOverride": null, + "schema": "abstractPagedBody", + }, + ], + "allOfPropertyConflicts": [], + "description": "Collection of transfers. The items in the collection are ordered in the \`items\` array. The response object may contain the \`nextPage_url\` pagination link..", + "generatedName": "Transfers", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "transfersItems", + "key": "items", + "schema": { + "description": "An array containing a page of transfer items.", + "generatedName": "TransfersItems", + "groupName": null, + "nameOverride": null, + "type": "array", + "value": { + "description": null, + "generatedName": "TransfersItemsItem", + "groupName": null, + "nameOverride": null, + "schema": "transferItem", + "type": "reference", + }, + }, + }, + { + "audiences": [], + "conflict": {}, + "generatedName": "transfersCount", + "key": "count", + "schema": { + "description": null, + "generatedName": "transfersCount", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The number of transfers that meet the filters in the \`listTransfers\` operation. This is optional and only included if the service can calculate it efficiently.", + "generatedName": "TransfersCount", + "groupName": null, + "nameOverride": null, + "schema": { + "type": "int", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + "wireTransferInstitution": { + "allOf": [ + { + "description": null, + "generatedName": "SimpleInstitution", + "groupName": null, + "nameOverride": null, + "schema": "simpleInstitution", + }, + ], + "allOfPropertyConflicts": [], + "description": "A representation of a financial institution used for wire transfers.", + "generatedName": "WireTransferInstitution", + "groupName": null, + "nameOverride": null, + "properties": [ + { + "audiences": [], + "conflict": {}, + "generatedName": "wireTransferInstitutionLocalClearingCode", + "key": "localClearingCode", + "schema": { + "description": null, + "generatedName": "wireTransferInstitutionLocalClearingCode", + "groupName": null, + "nameOverride": null, + "type": "optional", + "value": { + "description": "The clearing code used to identify the financial institution for select countries.", + "generatedName": "WireTransferInstitutionLocalClearingCode", + "groupName": null, + "nameOverride": null, + "schema": { + "maxLength": 12, + "minLength": 3, + "type": "string", + }, + "type": "primitive", + }, + }, + }, + ], + "type": "object", + }, + }, + "securitySchemes": { + "accessToken": { + "tokenEnvVar": null, + "tokenVariableName": null, + "type": "bearer", + }, + "apiKey": { + "headerEnvVar": null, + "headerName": "API-Key", + "headerVariableName": null, + "prefix": null, + "type": "header", + }, + }, + "servers": [ + { + "description": null, + "name": null, + "url": "https://api.apiture.com/banking", + }, + ], + "tags": { + "orderedTagIds": [ + "Accounts", + "Account Joint Owners", + "Overdraft Protection", + "Institutions", + "Schedules", + "Transactions", + "Transaction Categories", + "Transfers", + ], + "tagsById": { + "Account Joint Owners": { + "description": "Account Joint Owners", + "id": "Account Joint Owners", + }, + "Accounts": { + "description": "Banking Accounts", + "id": "Accounts", + }, + "Institutions": { + "description": "Banking Institutions", + "id": "Institutions", + }, + "Overdraft Protection": { + "description": "Overdraft Protection Settings", + "id": "Overdraft Protection", + }, + "Schedules": { + "description": "Schedules", + "id": "Schedules", + }, + "Transaction Categories": { + "description": "Banking Account Transaction Categories", + "id": "Transaction Categories", + }, + "Transactions": { + "description": "Banking Account Transactions", + "id": "Transactions", + }, + "Transfers": { + "description": "Banking Transfers", + "id": "Transfers", + }, + }, + }, + "title": "Apiture Digital Banking", + "variables": {}, + "webhooks": [], +} +`; diff --git a/packages/cli/openapi-parser/src/schema/examples/ExampleTypeFactory.ts b/packages/cli/openapi-parser/src/schema/examples/ExampleTypeFactory.ts index d871a86b05d..58badcd8209 100644 --- a/packages/cli/openapi-parser/src/schema/examples/ExampleTypeFactory.ts +++ b/packages/cli/openapi-parser/src/schema/examples/ExampleTypeFactory.ts @@ -518,11 +518,11 @@ export class ExampleTypeFactory { } case "datetime": if (example != null && typeof example === "string") { - return PrimitiveExample.datetime(new Date(example)); + return PrimitiveExample.datetime(example); } else if (schema.example != null) { - return PrimitiveExample.datetime(new Date(schema.example)); + return PrimitiveExample.datetime(schema.example); } else { - return PrimitiveExample.datetime(new Date("2024-01-15T09:30:00Z")); + return PrimitiveExample.datetime("2024-01-15T09:30:00Z"); } case "double": if (example != null && typeof example === "number") {