Accounts API: Certificate Summary

Similar to the main Account: Summary endpoint, this API contains a very basic listing of all the members sub-accounts for the account the member is signed in with. However, this API will only contain any Certificate sub-accounts. This endpoint also contains a bit more information on the sub-account, such as Available Balance.

API Endpoint

GET https://api.itsme247.com/v1.1/accounts/certificates

HTTP Headers

Status Key Value
Required CU*Answers-AppKey GUID
Required Accept application/json
Required Content-Type application/json
Optional CU*Answers-CUID 3 digit Credit Union ID

Response


[
  {
    "AvailableBalance": 0,
    "MaturityDate": "2017-03-20T13:41:56.763Z",
    "AccruedDividends": 0,
    "HasFundsHeld": true,
    "AccountId": "string",
    "AccountType": "string",
    "ApplicationType": "string",
    "AccountDescription": "string",
    "Balance": 0
  }
]
Parameter Type Description
AvailableBalance decimal The Available Balance takes into account all of the current pending transactions for this suffix.
MaturityDate datetime The date at which the Certificate is matured at full value.
AccruedDividends decimal The amount of dividends the certificate has accrued from the initial opening of the suffix.
HasFundsHeld boolean This is a true/false value based on whether there are any funds currently pending or on hold (for any reason) for this suffix.
AccountId string The “Suffix Number” of the account. This is generally a 3 character number, but could contain characters. It could also be longer than that and contain asterisk characters. In those cases, these are considered OTB (Off Trial Balance) accounts and only the last 4 characters will be seen, the rest masked.
AccountType string A short code of what the account is. Checking, Savings, Loan, etc…
ApplicationType string
AccountDescription string A “full name” of the suffix. This will contain the suffix code, and a nickname if the member has assigned on to the suffix. Otherwise it will contain the suffix code and a default name of the suffix.
Balance integer The current balance of the account. Note that this Available Balance, as it does not account for any pending transactions on this suffix.

Response Error

Check the error table below for information on the error codes that could be returned


{
  "ErrorCode": "string",
  "DisplayMessage": "string",
  "TechnicalMessage": "string",
  "Timestamp": "datetime""
}

Parameter Type Description
ErrorCode string The ErrorCode is a custom code we use to identify specific areas where something might have not worked right. Write it down and contact us if you continue to have issues.
DisplayMessage string This is generally something you can show to members when an error shows up. Though we encourage you to create your own message table based on the ErrorCode field above. We use these display messages for Online Banking, so you might see something tailored to a different application.
TechnicalMessage string This is a more detailed, developer-type message that migth help you in determining more of what’s going on. This should never be displayed to the member.
Timestamp datetime The date and time of the error. This is useful information to provide CU*Answers, should you need to contact us.

Error Codes

Code HTTP Code Description
OT12345764 500 Invalid characters were found within the challenge question. [ , ^, ]
SC12345915 500 Invalid challenge question length. Minimum of 3 characters.
NO12345749 500 Challenge question has an inappropriate word within the text.
SC12345913 500 Invalid security answers. Answers must be at least 3 characters.
NA12345747 500 Challenge questions must all be different.
NO12345749 500 Challenge answer has an inappropriate word within the text.
OT12345765 500 Invalid characters were found within the challenge answers. [ , ^, ]
ST12345702 500 Credit union not available during stand-in processing for end of day.
PC12345705 500 Member not authorized to access account based on PIB profile access times.
NF12345748 500 Missing Vendor login script. Contact CU*Answers.
NF12345734 500 Invalid Credit Union Id.
NF12345704 500 Application keys not found. Contact CU*Answers.
NA12345746 500 Online banking is not active for this Credit Union.
9999999999 500 Requested data not found.
8888888888 403 Requested data not found.
API2000 403 Forbidden: You are not authorized to use this resource.
API2010 403 Forbidden: You are not authorized to use this resource.
API2011 403 Forbidden: You are not authorized to use this resource. Whitelist Issue.
API2012 403 Forbidden: You are not authorized to use this resource.
API2013 403 Forbidden: You are not authorized to use the Accounts API.
API2014 403 Forbidden: You are not authorized to use the Members API.
API2015 403 Forbidden: You are not authorized to use the CreditUnions API.
API2016 403 Forbidden: You are not authorized to use the Transfers API.
API4000 403 Forbidden: You are not authorized to use this resource.
HTTP404 404 The location requested could not be found.
HTTP415 400 The media type requested is not supported. Please use application/json.
OB110 400 The AppKey is missing.
OB111 400 The session token is missing.
OB112 400 The user token is missing.
OB113 403 The id is missing.
OB201 403 The AppKey provided could not be verified.
OB202 403 The AppKey provided could not be verified against the credit union id.
OB203 403 Mismatch between AppKey and credit union id.
OB204 400 Credit union id could not be found. Please validate HttpHeader parameters are valid.
OB310 403 Data received is incomplete. Please validate the data being sent in and try again.
OB500 503 Online access is currently disabled, please try again later or contact the Credit Union for assistance.
OB503 500 [This message changes based on CU Configuration for maintenance]
OB510 500 Data could not be retrieved for this request, please try again or contact the Credit Union for assistance.
OB511 500 Data could not be retrieved for this request, please try again.
SC12345684 500 There was a problem processing your request. Please try again or contact CU*Answers.
NA12345746 500 Online banking is not active for this Credit Union.
NF12345703 500 There was a problem processing your request. Please try again or contact CU*Answers.
NF12345756 500 Data for loan account type not found.
SC12345735 401 Member not authenticated. Steps need completing.