API Documentation

Common Error Codes

The following are errors that can happen on any request to CorePro, depending on the request parameters, origin, intermediate network, etc. If present, these values will appear in the "errors" property of the envelope:

details

Code	Message (en-US)	HTTP Status Code	Notes
50401	User is not authorized	401	Check your configuration for proper CorePro API Key and Secret values against those in CorePro Admin console. Existing ones may have expired.
50403	IP is not trusted	403	Check the IP of the request. If it is a valid IP, contact CorePro support to whitelist it.
50404	The requested resource was not found.	404	The route is invalid or is not supported in the version associated with your API Key.
50405	The requested HTTP method is not allowed.	405	The route accepts a different HTTP method - did you issue a POST when you should have issued a GET for a particular route?
50429	Rate limit exceeded	429	Too many requests within a certain timeslice for your API Key. Wait a small amount of time and retry the request. If this happens regularly, contact CorePro support to increase your rate limit (additional fee may be applied)
50500	Internal Server Error	500	CorePro is experiencing issues. Please share your requestId with CorePro support.
50501	Not Implemented	501	The route is invalid. Verify your code is calling a documented CorePro route.
50502	Bad Gateway	502	Network connectivity issues between your server and CorePro servers, or CorePro is down for maintenance. Investigate, and if issues persist, contact CorePro support.
50503	Service Unavailable	503	CorePro servers are unavailable. You will need to try your request later.
50504	Gateway Timeout	504	Network connectivity issues between your server and CorePro servers, or CorePro is down for maintenance. Investigate, and if issues persist, contact CorePro support.
50505	HTTP Version Not Supported	505	HTTP/1.1 must be specified when using CorePro. Change your code to issue HTTP/1.1 requests.
52998	Internal Server Error. Incident Id : {0}	500	This is the catch-all error number for an internal server error. Please contact support@corepro.io with the Incidient Id provided in the message.
58150	QualiFile service call error received.	500	The content of this error message may be replaced by the actual one received from the QualiFile service call.
59001	No VerificationFundsAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59002	No RetailClearingAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59003	No ProgramExternalAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59004	No BankIncomeAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59005	No RegDFeeAmtForExceedingMonthlyMax configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59006	No RegDMonthlyTransWithdrawCountMax configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59007	Internal to Internal transfer is disabled for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59008	AllowedAccountTypeId is not configured properly for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59009	Program {0} does not have recurring contributions enabled.	400	You are unable to do recurring contributions because it is disabled for your program.
59010	Program {0} is not configured to require external account verification. Call /externalAccount/create instead.	400	Call `/externalAccount/create instead.`
59011	Program {0} is configured to require external account verification. Call /externalAccount/initiate instead.	400	Call `/externalAccount/initiate instead.`
59012	Program {0} is missing a ProgramReport record for the given date range and program.	400	Your program is configured incorrectly. Contact support@corepro.io
59013	No ProgramClearingAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59014	No MiscellaneousAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59015	No GeneralJournalAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59016	No CashAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59017	No RetailExternalAccount configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59018	No ProgramEcode.PercentToClient configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59019	No ProgramEcode.PercentToCorePro configured for program {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59020	Program {0} does not have account type {1} enabled.	400	Your program is configured incorrectly. Contact support@corepro.io
59102	No ProgramClearingAccount linked to ProgramExternalAccount {0}	400	Your program is configured incorrectly. Contact support@corepro.io
59103	All card numbers are already allocated for Program {0}.	400	Your program is configured incorrectly. Contact support@corepro.io
59900	Could not convert {0} to {1}: {2}. Path '{3}', line {4}, position {5}.	400	Invalid value passed in for a JSON property. The value could not be converted to the proper type. {0} = JSON type, {1} = destination type, {2} = value, {3} = property name, {4} = line number, {5} = character position. e.g.: "Could not convert string to decimal: 11..04. Path 'recurringContributionAmount', line 9, position 42."
59901	Invalid JavaScript property identifier character: {0}. Path '{1}', line {2}, position {3}.	400	Property name is missing opening quote character ('"'). {0} = property name, {1} = line number, {2} = character position. e.g.: "Invalid JavaScript property identifier character: ". Path 'targetDate', line 13, position 7."
59902	Expected ':' but got: {0}. Path '{1}', line {2}, position {3}.	400	Property name is missing closing quote character ('"'). {0} = first character of property name, {1} = property name, {2} = line number, {3} = character position. e.g.: "Expected ':' but got: S. Path 'targetDate', line 13, position 11."
59903	Invalid character after parsing property name. Expected ':' but got: =. Path '{0}', line {1}, position {2}.	400	Attempting to use "=" instead of ":" to separate property name and its value. {0} = property name (typically the name of the previous property, not the one with the issue), {1} = line number, {2} = character position. e.g.: "Invalid character after parsing property name. Expected ':' but got: =. Path 'tag', line 11, position 18."
59904	Error reading {0}. Unexpected token: StartArray. Path '{1}', line {2}, position {3}.	400	Passed an array value to a property which is not an array. {0} = destination type, {1} = property name, {2} = line number, {3} = character position. e.g.: "Error reading string. Unexpected token: StartArray. Path 'tag', line 10, position 11."
59905	Error parsing NaN value. Path '{0}', line {1}, position {2}.	400	Attempting to pass `null` for a property value, but using an invalid casing (such as `NULL` or `Null`). {0} = property name, {1} = line number, {2} = character position. e.g.: "Error parsing NaN value. Path 'tag', line 10, position 10."
59906	After parsing a value an unexpected character was encountered: ;. Path '{0}', line {1}, position {2}.	400	Attempting to use a semicolon (`;`) where a comma (`,`) should be used. {0} = property name, {1} = line number, {2} = character position. e.g.: "After parsing a value an unexpected character was encountered: ;. Path 'customerId', line 2, position 22."
59949	(Message varies)	400	A generic JSON parsing error occurred. See message for details. i.e. The JSON payload is not structured properly in some way.
59950	Unexpected end when deserializing object. Path '{0}', line {1}, position {2}.	400	Closing curly brace ("}") is missing in JSON payload. {0} = property name, {1} = line number, {2} = character position. e.g.: "Unexpected end when deserializing object. Path 'type', line 15, position 1."
59951	Error converting value "{0}" to type '{1}'. Path '', line {2}, position {3}.	400	Opening curly brace ("}") is missing in JSON payload. {0} = first property name in payload, {1} = (varies, ignore), {2} = line number, {3} = character position. e.g.: "Error converting value \"customerId\" to type 'CorePro.Business.Account'. Path '', line 2, position 15."
59952	Value for property '{0}' is not formatted as a valid ISO-8601 DateTime. Example value=2015-01-31T22:43:21.123+00:00	400	The value for the property is not formatted as an ISO-8601 date. e.g.: "Value for property 'targetDate' is not formatted as a valid ISO-8601 DateTime. Example value=2015-01-31T22:43:21.123+00:00"
59953	Value for property '{0}' is not formatted as a valid boolean. Valid values=true,false	400	The value for the property is not formatted as a boolean value. e.g.: "Value for property 'isCloseable' is not formatted as a valid boolean. Valid values=true,false"
59954	Value for property '{0}' is not formatted as a valid decimal (precision up to 2). Example value=1234.56	400	The value for the property is not formatted as a decimal value. e.g.: "Value for property 'targetAmount' is not formatted as a valid decimal (precision up to 2). Example value=1234.56"
59955	Value for property '{0}' is not formatted as a valid decimal (precision up to 11). Example value=1234.56789012345	400	The value for the property is not formatted as a decimal value. e.g.: "Value for property 'interestRateMonthly' is not formatted as a valid decimal (precision up to 2). Example value=1234.56789012345"
59956	Value for property '{0}' is not acceptable. Specifics: {1}	400	The value for the property could not be cast properly. e.g.: "Value for property 'customerId' is not acceptable. Specifics: Input string '12548a' is not a valid integer. Path 'customerId', line 2, position 23."
59957	Missing a closing curly brace. Specifics: {0}	400	JSON payload is missing a closing curly brace. e.g.: "Missing a closing curly brace. Unexpected end when deserializing object. Path 'type', line 12, position 1."
59958	Missing an opening curly brace. Specifics: {0}	400	JSON payload is missing an opening closing curly brace. e.g.: "Missing an opening curly brace. Specifics: Error converting value "customerId" to type 'CorePro.Business.Account'. Path '', line 2, position 15."
59999	(Message varies)	400	A generic JSON deserialization error occurred. See message for details. i.e. The JSON payload is not structured properly in some way.
60001	Customer id {0} is invalid.	400	Provide a valid customerId in the request
60002	Customer id {0} is inactive.	400	An inactive customer cannot perform any actions in CorePro. Redirect the user to a page informing them of this.
60003	Customer id {0} is not in a verified status.	400	An unverified customer cannot perform any actions in CorePro (except call /customer/verify). Redirect the user to a page informing them of this.
60004	Customer id {0} is locked.	400	An locked customer cannot perform any actions in CorePro. Redirect the user to a page informing them of this.
60005	Customer id {0} is marked as deceased.	400	An deceased customer cannot perform any actions in CorePro. Redirect the user to a page informing them of this.

Account

An account is a bank account belonging to exactly one customer and managed by CorePro. To correlate a specific account in CorePro to a specific account item in your system, use the tag property. An account is in contrast to an External Account which is managed by a different financial institution.

An account can be converted to a joint account by simply granting access to additional customers. There is no other distinction in CorePro API between an "account" and a "joint account" outside the concept of mutliple customers having access to an account.

account Object

Represents a single account in CorePro. A single customer can have several accounts.

details

Property	Data Type (length)	Description
`accountId`	integer	The unique identifier for an account.
`customerId`	integer	The unique identifier for the customer who owns the account.
`tag`	string (50)	A caller-specified, unique identifier for this account. Must be unique within a given Program. Maximum length is 50 characters.
`name`	string (50)	A caller-specified, user-friendly name for this account. Must be unique within a given Customer. Maximum length is 50 characters.
`accountNumber`	string (15)	Account number of the bank account. Generated at creation time. NOTE: Is emitted only if `isCloseable` = `false`
`accountNumberMasked`	string (15)	Masked version of the Account number of the bank account. e.g. ********1234
`routingNumber`	string (15)	Routing Transit Number (RTN) is a nine-digit bank code used to identify the financial institution where bank account is held. Read-only. NOTE: Is emitted only if `isCloseable` = `false`
`routingNumberMasked`	string (15)	Masked version of the Routing number of the bank account. e.g. ********1234
`status`	string (50)	Possible values include: `PendingOpen` `Open` `PendingClosed` `Closed` Note: Once an account is closed, it cannot be re-opened.
`type`	string (50)	Possible values include: `Prepaid` `Savings` (RegD restrictions apply) `Checking` `ForBenefitOf` (A more restrictive checking account) Note: Only certain type(s) of accounts are allowed within a given program; it depends upon your company's agreement with the corresponding financial institution.
`createdDate`	datetime	Date the account was created
`closedDate`	datetime	Date the account was closed
`accountBalance`	decimal	Total balance of account, including funds that have holds placed on them. Represents all settled transactions to date. This is the balance used for interest accrual calculations, if this is an interest-bearing account.
`availableBalance`	decimal	Balance available for immediate withdrawal. Settling a transaction for a DDA account will typically credit the `availableBalance` immediately. However, savings or FBO accounts may have a "deposit hold time" or a "new customer hold time", meaning there could be a length of time between when the transaction is settled and the corresponding funds are made available for withdrawal.
`pendingBalance`	decimal	Balance of pending deposit transactions. When a pending deposit transaction settles, it will debit this balance. Deposit transactions which settle immediately will never affect this balance.
`isPrimary`	boolean	True if this is the primary account for this customer. Read-only. Automatically set at customer or account creation time.
`isCloseable`	boolean	True if this is the account can be closed via `/account/close`. This property is assignable only at account creation time (cannot be updated).
`legalName1`	string (100)	The first legal name used to identify the account.
`legalName2`	string (100)	A secondary legal name used to identify the account.
The following set of properties are all releated to Joint Accounts. There is no special process for converting a "normal" account to a joint account. Once an account has more than one customer with access to it, it is considered a joint account. See the following routes for controlling access to an account: `/account/listAccess` `/account/editAccess`
`totalCustomers`	integer	The total number of customers with some type of access to the account.
`isJointAccount`	boolean	`true` if `totalCustomers` > 1, `false` otherwise
`primaryCustomerId`	integer	Denotes the customer considered the primary owner for the account. By default, this is the `customerId` passed when `/account/create` is called. It can be changed via `/account/edit`.
`isPrimaryCustomer`	boolean	True if the customerId passed in the route matches the `primaryCustomerId` on the account.
`accessTypeCode`	string (10)	The type of access the customerId passed in the route has to the account. Possible values include: `FULL` - customer can do anything with the account; read, withdraw funds, deposit funds `RDONLY` - customer can read data associated with the account, but not edit the account itself, withdraw funds, or deposit funds `NONE` - customer can do nothing with the account. Typically not returned via `/account/listAccess` (customers with `NONE` access type are filtered out), but is accepted via `/account/editAccess`
`customerPriority`	integer	The priority of ownership the customer has for the account. Primary owner always has a `customerPriority` of 1. Joint owners have a `customerPriority` of 2 or higher. This value is unique and sequential amongst all active owners for a given account. Lower numbers indicate higher priority of ownership. Upon death of the primary owner, the joint account ownership will shift to the account owner with a `customerPriority` of 2, if any. This can be set only by calling /account/editAccess to add or remove a customer from an account.
`lastModifiedDate`	datetime	Date when the object was last altered in any way (excluding the balance properties -- see `balanceLastModifiedDate` property below)
`balanceLastModifiedDate`	datetime	Date when any of `accountBalance`, `availableBalance`, or `pendingBalance` for the account were last altered in any way
All properties beginning with `recurringContribution` require the program to have Recurring Contributions enabled. This is an optional feature that requires an additional subscription fee. If your program does not have this enabled and recurringContributionType is specified as a valid value other than `None` or empty string when calling /account/create or /account/update, runtime error 59009 will occur.
`recurringContributionType`	string (50)	The frequency with which recurring contributions occur. If omitted on a create, `None` is assumed. Valid values include: `Monthly` `BiWeekly` `None`
`recurringContributionAmount`	decimal	The amount to contribute on a recurring basis.
`recurringContributionFromExternalAccountId`	integer	The `externalAccountId` from which funds will be transferred on a recurring basis. Refers to an `externalAccount` object.
`recurringContributionStartDate`	datetime	The earliest date on which future recurring contributions should start. Note if the day specified is less than or equal to "tomorrow", the first recurring contribution will occur the following period. So if today is the 8th and a value between 1 and 9 is specified, the first recurring contribution will happen the following period. If a value between 10 and 28 is specified, the first recurring contribution will happen during the current period. The value for the day portion of the date must be between 1 and 28.
`recurringContributionEndDate`	datetime	The earliest date on which future recurring contributions should end. Must be greater than the `recurringContributionStartDate`. If `recurringContributionEndDate` is in the past, effectively this effectively disables recurring contributions. i.e. same behavior as though `recurringContributionType` = `None`.
`recurringContributionNextDate`	datetime	The date the next recurring contribution is scheduled to occur. This property is read-only, but setting `recurringContributionStartDate` causes this date to change.
The following are all completely optional properties.
`targetAmount`	decimal	The amount the customer wants the `availableAmount` to reach.
`targetDate`	datetime	The date the customer would like the `targetAmount` to be reached.
`targetMetDate`	datetime	The first date the `availableAmount` reached or exceeded the `targetAmount`. Since a customer may withdraw funds then deposit more funds without closing an account, it is possible to surpass the `targetAmount` multiple times. However, the `targetMetDate` is updated only on the first time, not on the second or any subsequent times.
`targetMetPercent`	decimal	The percent of progress towards reaching the `targetAmount`. Essentially `availableBalance` / `targetAmount`. Rounded to 2 decimals of precision.
`category`	string (50)	The category to which this account belongs. Freeform. Useful for grouping and trending in reports.
`subCategory`	string (50)	The subcategory to which this account belongs. Freeform. Useful for grouping and trending in reports.
`customField1`	string (50)	A property for holding client-defined data. There is no business logic in CorePro for a custom field.
`customField2`	string (50)	A property for holding client-defined data. There is no business logic in CorePro for a custom field.
`customField3`	string (50)	A property for holding client-defined data. There is no business logic in CorePro for a custom field.
`customField4`	string (50)	A property for holding client-defined data. There is no business logic in CorePro for a custom field.
`customField5`	string (50)	A property for holding client-defined data. There is no business logic in CorePro for a custom field.

close

Closes an account.
If the account balance is greater than 0 or any interest is owed on this account, then those amounts are calculated and a transaction is implicitly created with the sum of those amounts being credited into the given closeToAccountId.
That transaction's tag property is also assigned the value in the transactionTag property, if specified.

POST /account/close

Request Body Parameters

`customerId`	Required	Customer ID (returned when customer originally created)
`accountId`	Required	The `accountId` of the `account` to close.
`closeToAccountId`	Optional *	The `accountId` of the `account` or the `externalAccountId` of the `externalAccount` where any funds in the closing account are to be transferred. * If there is a balance on this account OR this is an interest-bearing account and interest is owed, `closeToAccountId` is a required parameter.
`transactionTag`	Optional	A program-wide unique identifier supplied by the caller that is to be associated with the transaction created to move any funds out of the account being closed.

NOTE: The properties returned from this call are completely different than all other /account routes. It does not return an account object. It returns details of the account closure process that could be useful.

Response Data

`customerId`	Customer ID (returned when customer originally created)
`accountId`	The `accountId` of the `account` to close.
`closeToAccountId`	The `accountId` of the `account` or the `externalAccountId` of the `externalAccount` where any funds in the closing account are to be transferred.
`transactionId`	A program-wide unique identifier created by CorePro that represents the transaction used to move the remaining funds to the `closeToAccountId` account.
`transactionTag`	A program-wide unique identifier supplied by the caller that is to be associated with the transaction created to move any funds from the closing account.
`closingBalanceAmount`	The balance of the account at close time prior to any interest being paid.
`interestPaidAmount`	The amount of interest paid at time of close.
`totalClosingAmount`	The total amount of funds transferred to the given `closeAccountId` at time of close. NOTE: `closingBalanceAmount` + `interestPaidAmount` will equal `totalClosingAmount`, unless Backup Withholding is enabled for that customer. If Backup Withholding is enabled, its amount is 28% of total interest earned, meaning the `interestPaidAmount` returned in that case is 72% of total interest earned.
`isClosedToExternalAccount`	`true` if the `closeToAccountId` was an external account. `false` otherwise.

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
65901	Invalid account id '{0}'.
65902	Invalid closing account id '{0}'.
65903	Transaction with tag '{0}' already exists.
65904	Closing account id '{0}' is deactivated.
65905	Closing account id '{0}' is not yet verified.
65906	Closing account id '{0}' is not open.
65907	Account id '{0}' and close to account id '{1}' cannot be the same.
65908	Cannot close an account with pending transactions or funds on hold.
65909	Cannot close an account with a negative balance.
65910	Account id '{0}' is not allowed to be closed.	The `isCloseable` flag is set to `true` for this account, preventing the close from succeeding. To force a close, use the CorePro Admin console to perform this functionality.
65911	Invalid close to account id '{0}'.
65912	CloseToAccountId {1} does not match Cash account configured for program '{0}'.
65913	Account id '{0}' is already pending closure.
65914	Account id '{0}' is already closed.
65916	Customer id '{0}' has insufficient privileges to close account id '{1}'.
65917	Customer id '{0}' has insufficient privileges to deposit funds into account id '{1}'.
65918	Account id '{0}' is still associated with card id '{1}'. Call /card/removeAccount to disassociate, then retry your request.
65920	Invalid NetAccountValue of {0}. Contact support.

Example

Request

POST /account/close
Authorization: Basic PutBase64TokenHere

{
  "customerId": 33,
  "accountId" : 80,
  "closeToAccountId" : 27,
  "transactionTag" : "oiwjo28c"
}

Response

{
  "data": {
    "accountId": 80,
    "closeToAccountId" : 27,
    "transactionId" : 23894723,
    "transactionTag" : "oiwjo28c",
    "closingBalanceAmount" : 32.98,
    "interestPaidAmount" : 0.82,
    "totalClosingAmount" : 33.80,
    "isClosedToExternalAccount" : true
  },
  "errors": [],
  "status": 200
}

create

Create a new account for a customer

POST /account/create

Request Body Parameters

`customerId`	Required	Customer ID (returned when customer originally created)
`name`	Required	The name to apply to this account.
`type`	Required	Acceptable values are `Prepaid`, `Checking`, `Savings`, or `ForBenefitOf`. However, each program defines which type(s) of account that are actually allowed for that particular program.
`targetAmount`	Optional	The amount the customer wants this account to reach.
`targetDate`	Optional	The date by which the customer wants this account to reach the given targetAmount.
`isCloseable`	Optional	This flag determines if the account can be closed via `/account/close`. `true` denotes it can be closed at any time via `/account/close`. `false` denotes it must be closed via the CorePro Admin console. This requires human interaction and cannot be automated. Defaults to `true`.
`category`	Optional	Freeform text which can be used to categorize accounts, useful for analytics.
`subcategory`	Optional	Freeform text which can be used to further subcategorize accounts, useful for analytics.
`tag`	Optional	A program-wide unique identifier supplied by the caller to associate with the new account.
`recurringContributionType`	Optional	Accepted values are "None", "BiWeekly", and "Monthly". Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionAmount`	Required if `recurringContributionType` is any value except `None`	Amount to deposit each recurring contribution period. Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionFromExternalAccountId`	Required if `recurringContributionType` is any value except `None`	External account from which recurring contributions are withdrawn. Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionStartDate`	Required if `recurringContributionType` is any value except `None`	Date to start the first recurring contribution period. Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionEndDate`	Required if `recurringContributionType` is any value except `None`	Date to end the last recurring contribution period. Applicable only if the program has opted into the recurring contribution feature set.
`customField1`	Optional	Any value up to 50 characters in length
`customField2`	Optional	Any value up to 50 characters in length
`customField3`	Optional	Any value up to 50 characters in length
`customField4`	Optional	Any value up to 50 characters in length
`customField5`	Optional	Any value up to 50 characters in length

Response Data

. Note the given customerId is assigned as the primaryCustomerId for the new account.

The `accountId` of the new `account` Object

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
61002	An account with the name '{0}' already exists.
61003	Name is a required field.
61004	Account must be specified with a Type of '{0}'.
61005	Tag '{0}' is already associated with another account.
61006	Recurring contribution type '{0}' is invalid. Valid values are: 'None', 'BiWeekly', and 'Monthly'.
61007	Recurring contribution type '{0}' is invalid. Valid values are: 'None', 'BiWeekly', and 'Monthly'.
61008	A recurring contribution amount must be at least {0:C}.
61009	External account id '{0}' for the recurring contribution is invalid.
61010	A recurring contribution must be scheduled to start between the 1st and the 28th of the month.
61011	A recurring contribution start date must occur before its end date.
61012	A recurring contribution start date must be specified.
61013	Maximum number of accounts for this customer has been reached.	One or more accounts must be closed before new accounts can be opened.
61014	Customer status is '{0}'. To create an account, customer status must be Verified or ManualReview.
61015	Target amount can not exceed {0:C}.
61016	A maximum of '{0}' open accounts are allowed.
61017	Recurring contribution amount must be between {0:C} and {1:C}.
61018	Only one account can be created while a customer is in ManualReview.
61019	Account Number '{0}' must be numeric.
61020	Account Number '{0}' is already in use.

Example

Request

POST /account/create
Authorization: Basic PutBase64TokenHere

{
  "customerId": 33,
  "type": "Savings",
  "name": "Savings #2"
}

Response

{
  "data": {
    "accountId": 1583010
  },
  "errors": [],
  "status": 200
}

get

Retrieve a single account for the given customerId and accountId

GET /account/get/{customerId}/{accountId}

Request Parameters

`customerId`	Required	Customer ID (returned when customer was created)
`accountId`	Required	Account ID (returned when the account was created)

Response Data

An `account` Object

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
66001	Invalid account id '{0}'.

Example

Request

GET /account/get/231/234
Authorization: Basic PutBase64TokenHere

Response

{
  "data": {
      "accountBalance": 0.0000,
      "accountId": 234,
      "accountNumber": "00000000000000097",
      "accountNumberMasked": "*************0097",
      "availableBalance": 0.0000,
      "category": "",
      "closedDate": "9999-12-31T23:59:59.999+00:00",
      "createdDate": "2014-02-24T16:49:25.465-06:00",
      "customerId": 231,
      "customField1": "ABCD",
      "isCloseable": false,
      "isPrimary" : true,
      "name": "Savings",
      "recurringContributionFromExternalAccountId": 0,
      "recurringContributionStartDate": "2014-02-01T00:00.000-06:00",
      "recurringContributionType": "None",
      "routingNumber": "8675309",
      "status": "Open",
      "subCategory": "",
      "tag": "tagabc",
      "type": "Prepaid"
  },
  "errors": [],
  "status": 200
}

getByTag

Retrieve a single account for the given customerId and tag

GET /account/getByTag/{customerId}/{tag}

Request Parameters

`customerId`	Required	Customer ID (returned when customer was created)
`tag`	Required	A program-wide unique identifier supplied by the caller at account creation time.

Response Data

An `account` Object

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
65801	Tag must be specified.
66101	Tag '{0}' does not exist or is not tied to customer {1}.

Example

Request

GET /account/getByTag/231/tagabc
Authorization: Basic PutBase64TokenHere

Response

{
  "data": {
      "accountBalance": 0.0000,
      "accountId": 234,
      "accountNumber": "00000000000000097",
      "accountNumberMasked": "*************0097",
      "availableBalance": 0.0000,
      "category": "",
      "closedDate": "9999-12-31T23:59:59.999+00:00",
      "createdDate": "2014-02-24T16:49:25.465-06:00",
      "customerId": 231,
      "customField1": "ABCD",
      "isCloseable": false,
      "name": "Savings",
      "routingNumber": "8675309",
      "status": "Open",
      "subCategory": "",
      "tag": "tagabc",
      "type": "Prepaid"
  },
  "errors": [],
  "status": 200
}

list

Retrieve all accounts for the given customerId. Accounts in a status of Closed may disappear from this list after a period of time no shorter than 32 days.

GET /account/list/{customerId}

Request Parameters

`customerId`	Required	Customer ID (returned when customer was created)

Response Data

A list of `account` Objects

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes

Example

Request

GET /account/list/231
Authorization: Basic PutBase64TokenHere

Response

{
  "data": [
    {
      "accountBalance": 0.0000,
      "accountId": 234,
      "accountNumber": "00000000003200097",
      "accountNumberMasked": "*************0097",
      "availableBalance": 0.0000,
      "category": "",
      "closedDate": "9999-12-31T23:59:59.999+00:00",
      "createdDate": "2014-02-24T16:49:25.465-06:00",
      "customerId": 231,
      "customField1": "ABCD",
      "isCloseable": false,
      "isPrimary" : true,
      "name": "Savings",
      "recurringContributionFromExternalAccountId": 0,
      "recurringContributionStartDate": "2014-02-01T00:00.000-06:00",
      "recurringContributionType": "None",      
      "routingNumber": "8675309",
      "status": "Open",
      "subCategory": "",
      "tag": "tagabc",
      "type": "Prepaid"
    },
    {
      "accountBalance": 0.0000,
      "accountId": 275,
      "accountNumberMasked": "*************0130",
      "availableBalance": 0.0000,
      "closedDate": "9999-12-31T23:59:59.999+00:00",
      "createdDate": "2014-02-25T16:19:22.472-06:00",
      "customerId": 231,
      "customField1": "ABCD",
      "isCloseable" : true,
      "isPrimary" : false,
      "name": "Brocko Testo2",
      "recurringContributionFromExternalAccountId": 0,
      "recurringContributionStartDate": "2014-02-01T00:00.000-06:00",
      "recurringContributionType": "None",
      "status": "Open",
      "tag": "test2",
      "targetAmount": 560.0000,
      "targetDate": "2017-12-31T00:00:00.000-06:00",
      "type": "Savings"
    }
  ],
  "errors": [],
  "status": 200
}

update

Update account information

POST /account/update

Request Body Parameters

`customerId`	Required	Customer ID (returned when customer was created)
`accountId`	Required	Account ID for the account (returned when account was created)
`name`	Required	The name to apply to this account.
`targetAmount`	Optional	The amount the customer wants this account to reach.
`targetDate`	Optional	The date by which the customer wants this account to reach the given targetAmount.
`targetMetDate`	N/A	This property can only be updated indirectly by depositing funds into the `account` by calling `/transfer/create` or submitting a `Bulk Transfer Request File`.
`targetMetPercent`	N/A	This property can only be updated indirectly by depositing funds into the `account` by calling `/transfer/create` or submitting a `Bulk Transfer Request File`.
`isCloseable`	N/A	This property cannot be updated. To close an `account` with `isCloseable`=`false`, it must be done via the Admin console.
`category`	Optional	Freeform text which can be used to categorize accounts, useful for analytics.
`subcategory`	Optional	Freeform text which can be used to further subcategorize accounts, useful for analytics.
`tag`	Optional	A program-wide unique identifier supplied by the caller to associate with the new account.
`recurringContributionType`	Optional	Accepted values are: `None` `BiWeekly` `Monthly` Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionAmount`	Required if `recurringContributionType` in the request or currently stored for that account is any value except `None`.	Amount to deposit each recurring contribution period. Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionFromExternalAccountId`	Required if `recurringContributionType` in the request or currently stored for that account is any value except `None`.	External account from which recurring contributions are withdrawn. Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionStartDate`	Required if `recurringContributionType` in the request or currently stored for that account is any value except `None`.	Date to start the first recurring contribution period. Applicable only if the program has opted into the recurring contribution feature set.
`recurringContributionEndDate`	Required if `recurringContributionType` in the request or currently stored for that account is any value except `None`.	Date to end the last recurring contribution period. Applicable only if the program has opted into the recurring contribution feature set.
`customField1`	Optional	Any value up to 50 characters in length
`customField2`	Optional	Any value up to 50 characters in length
`customField3`	Optional	Any value up to 50 characters in length
`customField4`	Optional	Any value up to 50 characters in length
`customField5`	Optional	Any value up to 50 characters in length

Response Data

No object is returned; the envelope's "data" property will be absent, but a status of 200 is returned upon success.

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
61101	Invalid AccountId: {0}
61102	An account with the name '{0}' already exists.
61103	Recurring contribution type '{0}' is invalid. Valid values are: `None` `BiWeekly` `Monthly` .
61104	Recurring contribution type '{0}' is invalid. Valid values are: `None` `BiWeekly` `Monthly` .
61105	A recurring contribution amount must be at least {0:C}.
61106	External account id '{0}' for the recurring contribution is invalid.
61107	Tag '{0}' is already associated with another account.
61108	A recurring contribution must be scheduled to start between the 1st and the 28th of the month.
61109	A recurring contribution start date must occur before its end date.
61110	Target date must be in the future.
61111	Account '{0}' is closed and cannot be updated.
61112	Account Number '{0}' must be numeric.
61113	Account Number '{0}' is already in use.
61114	Target amount can not exceed {0:C}.
61115	Recurring contribution amount must be between {0:C} and {1:C}.
61116	A recurring contribution start date must be specified.
61117	Insufficient privileges to change account number.
61118	Customer id '{0}' has insufficient privileges to edit account id '{1}'.
61119	Customer id '{0}' has insufficient privileges to credit account id '{1}', and therefore cannot schedule recurring contributions for it.
61120	Customer id '{0}' has insufficient privileges on account id '{1}' to reassign the primary customer id to '{2}'.

Example

Request

POST /account/update
Authorization: Basic PutBase64TokenHere

{
  "accountId": 1562412,
  "customerId": 33,
  "name": "My Favorite Savings Account"
}

Response

{
  "data": {
    "accountId": 1562412
  },
  "errors": [],
  "status": 200
}

listAccess

Retrieve all customers associated with the given accountId. Excludes any customers with an access type of NONE.

GET /account/listaccess/{customerId}/{accountId}

Request Parameters

`customerId`	Required	Customer ID (returned when customer was created)
`accountId`	Required	Account ID (returned when account was created)

Response Data

A list of `accountAccess` Objects

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
108501	CustomerId {0} has insufficient privileges ({1}) to list access types on accountId {2}. FULL access is required.	Given `customerId` needs read access to the given `accountId` to see privileges.
108502	AccountId is a required parameter.

Example

Request

GET /account/listaccess/1587412/1587427
Authorization: Basic PutBase64TokenHere

Response

{
  "data": [
    {
      "accessTypeCode": "FULL",
      "accountId": 1587427,
      "accountName": "A-412",
      "accountNumber": "101010",
      "accountNumberMasked": "*************1010",
      "accountTag": "",
      "customerId": 1587412,
      "customerPriority": 1,
      "customerTag": "2016-06-29bw4",
      "emailAddress": "2016-06-25_b@no.com",
      "firstName": "John",
      "isPrimaryCustomer": true,
      "lastName": "Smith",
      "middleName": "",
      "primaryCustomerId": 1587412,
      "routingNumber": "111222333",
      "routingNumberMasked": "*****2333",
      "suffix": ""
    },
    {
      "accessTypeCode": "FULL",
      "accountId": 1587427,
      "accountName": "A-412",
      "accountNumber": "101010",
      "accountNumberMasked": "*************1010",
      "accountTag": "",
      "customerId": 1587417,
      "customerPriority": 2,
      "customerTag": "2016-06-29bw5",
      "emailAddress": "2016-06-25_b@no.com",
      "firstName": "John",
      "isPrimaryCustomer": false,
      "lastName": "Smith",
      "middleName": "",
      "primaryCustomerId": 1587412,
      "routingNumber": "111222333",
      "routingNumberMasked": "*****2333",
      "suffix": ""
    }
  ],
  "errors": [],
  "requestId": "cbc24d85-220b-485c-bfb0-bfd13642fc65",
  "status": 200
}

editAccess

Edit the access type for a given customer with respect to a given account

Adding a customer to or removing a customer from an account is also performed via this route. To remove, pass NONE as the accessTypeCode.

POST /account/editaccess

Request Parameters

`customerId`	Required	A customer ID already associated with the account that has an existing access type of `FULL`
`accountId`	Required	The accountId of the relevant account
`targetCustomerId`	Required	The customer ID whose access type is being edited
`accessTypeCode`	Required	The type of access `customerId` has to `accountId`. Possible values include: `FULL` - customer can do anything with the account; read, withdraw funds, deposit funds `RDONLY` - customer can read data associated with the account, but not edit the account itself, withdraw funds, or deposit funds `NONE` - customer can do nothing with the account. Subsequent `/account/listAccess` requests will not include this customer as being associated with this account.
`customerPriority`	Optional	The priority of the customer on this account. If not specified, will be given the lowest priority. If a priority higher than the current maximum on the account is specified, the priority will be defaulted to a value equal to the maximum priority plus one.

Response Data

The revised version of the `accountAccess` object.

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
108201	CustomerId {0} must retain FULL access type until another customer is assigned as the Primary Customer for accountId {1}.	An account's primary customer must always have `FULL` access
108202	CustomerId {0} cannot elevate its own access type on accountId {1} to {2}.	Specify a `customerId` with `FULL` access to the account to elevate privileges for `targetCustomerId`.
108204	CustomerId {0} must have access type of FULL on accountId {1} to alter access for TargetCustomerId {2} to {3}.	Specify a `customerId` with `FULL` access to the account to alter the privileges for `targetCustomerId`.
108205	Invalid TargetCustomerId {0}.
108206	TargetCustomerId {0} is in a status of {1} and account access can be altered only to NONE.
108207	AccessTypeCode was left blank and is a required field. Valid code values are FULL, RDONLY, or NONE.
108208	AccessTypeCode {0} is invalid. Valid code values are FULL, RDONLY, or NONE.
108209	NewCustomerPriority {0} is invalid. Please enter an integer greater than 0.

Example

Request

POST /account/editaccess
Authorization: Basic PutBase64TokenHere

{
  "accessTypeCode": "FULL",
  "accountId": 1587427,
  "customerId": 1587412,
  "targetCustomerId": 1587417,
  "customerPriority": 2
}

Response

    {
  "data": {
    "accessTypeCode": "FULL",
    "accountId": 1587427,
    "customerId": 1587412,
    "isPrimaryCustomer": false,
    "targetCustomerId": 1587417,
    "customerPriority": 2
  },
  "errors": [],
  "requestId": "a0a705ec-5a23-45d2-8d2f-4ad4f3425934",
  "status": 200
}

API Documentation

Common Error Codes

details

Account

account Object

details

close

POST /account/close

Request Body Parameters

Response Data

Error Codes

Example

Request

Response

create

POST /account/create

Request Body Parameters

Response Data

Error Codes

Example

Request

Response

get

GET /account/get/{customerId}/{accountId}

Request Parameters

Response Data

Error Codes

Example

Request

Response

getByTag

GET /account/getByTag/{customerId}/{tag}

Request Parameters

Response Data

Error Codes

Example

Request

Response

list

GET /account/list/{customerId}

Request Parameters

Response Data

Error Codes

Example

Request

Response

update

POST /account/update

Request Body Parameters

Response Data

Error Codes

Example

Request

Response

listAccess

GET /account/listaccess/{customerId}/{accountId}

Request Parameters

Response Data

Error Codes

Example

Request

Response

editAccess

POST /account/editaccess

Request Parameters

Response Data

Error Codes

Example

Request

Response

Ready to start a conversation?