API Documentation

[Mobile] Table of Contents:

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.

Program

limit Object

Represents a minimum and maximum decimal value. Currently used only by /program/object

details

Property Data Type
(length)		 Description
minimumAmount decimal The minimum amount allowed. Inclusive.
maximumAmount decimal The maximum amount allowed. Inclusive.

program Object

Represents all program-level settings associated with the current login creditials. All values are read-only.

details

Property Data Type
(length)		 Description
decimalCount int Number of significant digits to the right of the decimal for all monetary properties. Will always be a value between 0 and 4. Does NOT apply to interest rate properties.
filledDate datetime Date the program values were last refreshed from the database. For performance reasons, they are cached for up to 5 minutes. i.e. if changes are made to any of these settings via the CorePro Admin Console, it will take up to 5 minutes for them to propagate to the CorePro API.
isInterestEnabled boolean true if interest is accrued for accounts in this program, false otherwise.
isInternalToInternalTransferEnabled boolean true if transferring funds between two CorePro accounts is allowed, false otherwise. NOTE: both accounts must be owned by the same customer.
isRecurringContributionEnabled boolean true if the recurring contribution feature of CorePro is enabled for this program. false otherwise.
name string (50) The name of the program
perProgramDailyDepositLimit limit object The minimum and maximum amount of the sum of all deposits that can be performed on a single day across all accounts and all customers within this program.
perProgramDailyWithdrawLimit limit object The minimum and maximum amount of the sum of all withdrawals that can be performed on a single day across all accounts and all customers within this program.
perTransactionDepositLimit limit object The minimum and maximum amount allowed that can be deposited in a single transaction.
perTransactionWithdrawLimit limit object The minimum and maximum amount allowed that can be withdrawn in a single transaction.
perUserDailyDepositLimit limit object The minimum and maximum amount of all deposits that can be performed on a single day across all accounts for a given customer.
perUserDailyWithdrawLimit limit object The minimum and maximum amount of all withdrawals that can be performed on a single day across all accounts for a given customer.
perUserMonthlyDepositLimit limit object The minimum and maximum amount of all deposits that can be performed during a single month across all accounts for a given customer.
perUserMonthlyWithdrawLimit limit object The minimum and maximum amount of all withdrawals that can be performed during a single month across all accounts for a given customer.
regDFeeAmount decimal The fee amount to apply to all withdrawal transactions for a given customer after the limit defined by regDMonthlyTransactionWithdrawCountMax. Applies only to account with type = Savings
regDMonthlyTransactionWithdrawCountMax int The number of withdrawals per month across all accounts with type = Savings for a given customer before the regDFeeAmount is applied.
timeZone string (50) The timezone all dates will be recorded in. Note the same time zone applies to all programs for a given bank.
verificationType string (50) The type of verification required when creating a new customer. Possible values are:
  • None
  • OFAC Only
  • Full
website string (50) The url associated with this program. Informational only, serves no functional purpose to CorePro.
accounts A list of programAccount objects CorePro accounts associated with your program, not with any particular customer.
externalAccounts A list of programExternalAccount objects External accounts associated with your program, not with any particular customer.
products A list of product objects The products configured for your program. Please contact support to modify existing products or add new ones.
checkingProducts A dictionary with a single product object

Deprecated; Filter by type = 'Checking' in the products array

The original product with type = 'Checking' created for your program. The dictionary key is checking.
prepaidProducts A dictionary with a single product object

Deprecated; Filter by type = 'Prepaid' in the products array

The original product with type = 'Prepaid' created for your program. The dictionary key is prepaid.
savingsProducts A dictionary with a single product object

Deprecated; BFilter by type = 'Savings' in the products array

The original product with type = 'Savings' created for your program. The dictionary key is prepaid.
publicKeyAlgorithms string (200) The list of algorithms approved for use by your program needed by any public key encryption required by the API. Note CorePro API uses the Bouncy Castle Library for decryption.
  • RSA-OAEP-SHA1-MGF1
    • C# (Bouncy Castle provider) - Sha1Digest()
    • Java (Bouncy Castle provider) - RSA/NONE/OAEPWithSHA1AndMGF1Padding, BC
    • Java (Default provider) - RSA/ECB/OAEPWITHSHA-1ANDMGF1PADDING
    • Python (PyCrypto) - Crypto.Cipher.PKCS1_OAEP, Crypto.Hash.SHA
    • Ruby - OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING
    • NodeJS - crypto.constants.RSA_PKCS1_OAEP_PADDING
    • PHP - OPENSSL_PKCS1_OAEP_PADDING
  • RSA-OAEP-SHA256-MGF1
    • C# (Bouncy Castle provider) - Sha256Digest()
    • Java (Bouncy Castle provider) - RSA/NONE/OAEPWithSHA256AndMGF1Padding, BC
    • Java (Default provider) - Unsupported
    • Python (PyCrypto) - Crypto.Cipher.PKCS1_OAEP, Crypto.Hash.SHA256
    • Ruby - N/A
    • NodeJS - N/A
    • PHP - N/A
  • RSA-OAEP-SHA384-MGF1
    • C# (Bouncy Castle provider) - Sha384Digest()
    • Java (Bouncy Castle provider) - RSA/NONE/OAEPWithSHA384AndMGF1Padding, BC
    • Java (Default provider) - Unsupported
    • Python - N/A
    • Ruby - N/A
    • NodeJS - N/A
    • PHP - N/A
  • RSA-OAEP-SHA512-MGF1
    • C# (Bouncy Castle provider) - Sha512Digest()
    • Java (Bouncy Castle provider) - RSA/NONE/OAEPWithSHA512AndMGF1Padding, BC
    • Java (Default provider) - Unsupported
    • Python - N/A
    • Ruby - N/A
    • NodeJS - N/A
    • PHP - N/A

get

Retrieve program settings for the current program.

Note: When you provide an invalid identifier (id,tag, or emailAddress), all routes ending with /get returns 400 (Bad Request).

GET /program/get

Request Parameters

N/A    

Response Data

A program Object

Error Codes

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

Example

Request
GET /program/get
Authorization: Basic PutBase64TokenHere
Response
200

    HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Date: Mon, 15 Dec 2014 21:37:25 GMT
Content-Length: 3998
{
  "data": {
    "checkingProducts": {},
    "decimalCount": 2,
    "eCodeProducts": {
      "amazon": {
        "category": "eCode",
        "imageUrl": {
          "en-US": "https://d12eobaimzi14r.cloudfront.net/faceplates/D2V69VFJ/CAROUSEL-1.jpg"
        },
        "isReissueSupported": false,
        "maximumAmount": 500.0,
        "minimumAmount": 5.0,
        "name": {
          "en-US": "Amazon.com"
        },
        "productCode": "AMAZON",
        "programECodeId": 4201,
        "type": "amazon"
      },
      "gap": {
        "category": "eCode",
        "imageUrl": {
          "en-US": "https://d12eobaimzi14r.cloudfront.net/faceplates/D3S24HSSS/CAROUSEL-1.jpeg"
        },
        "isReissueSupported": true,
        "maximumAmount": 500.0,
        "minimumAmount": 10.0,
        "name": {
          "en-US": "Gap"
        },
        "productCode": "GAP",
        "programECodeId": 4193,
        "type": "gap"
      },
      "overstock": {
        "category": "eCode",
        "imageUrl": {
          "en-US": "https://d12eobaimzi14r.cloudfront.net/faceplates/DDF3ZMC5A/CAROUSEL-2.jpg"
        },
        "isReissueSupported": true,
        "maximumAmount": 500.0,
        "minimumAmount": 5.0,
        "name": {
          "en-US": "Overstock.com"
        },
        "productCode": "OVERSTOCK",
        "programECodeId": 4195,
        "type": "overstock"
      },
      "thd": {
        "category": "eCode",
        "imageUrl": {
          "en-US": "https://d12eobaimzi14r.cloudfront.net/faceplates/DDFHXTZQ2/CAROUSEL-1.jpeg"
        },
        "isReissueSupported": false,
        "maximumAmount": 500.0,
        "minimumAmount": 25.0,
        "name": {
          "en-US": "The Home Depot"
        },
        "productCode": "THD",
        "programECodeId": 4199,
        "type": "thd"
      }
    },
    "filledDate": "2014-12-15T21:37:19.144+00:00",
    "isInternalToInternalTransferEnabled": true,
    "name": "CoreProPrepaidTester",
    "perProgramDailyDepositLimit": {
      "maximumAmount": 999999999.99,
      "minimumAmount": 0.0
    },
    "perProgramDailyWithdrawLimit": {
      "maximumAmount": 999999999.99,
      "minimumAmount": 0.0
    },
    "perUserAccountCountMax": 100,
    "perUserDailyDepositLimit": {
      "maximumAmount": 500.0,
      "minimumAmount": 0.0
    },
    "perUserDailyWithdrawLimit": {
      "maximumAmount": 500.0,
      "minimumAmount": 0.0
    },
    "perUserExternalAccountCountMax": 1,
    "perUserMonthlyDepositLimit": {
      "maximumAmount": 1000.0,
      "minimumAmount": 0.0
    },
    "perUserMonthlyWithdrawLimit": {
      "maximumAmount": 1000.0,
      "minimumAmount": 0.0
    },
    "perUserTotalAccountBalanceMax": 99999999.0,
    "products": [{
        "balanceLimit": {
          "maximumAmount": 99999999.0,
          "minimumAmount": 0.0
        },
        "category": "Prepaid",
        "interestRates": [
          {
            "apr": 0.00000000000,
            "apy": 0.00000000000,
            "maximumAmount": 0.0000,
            "minimumAmount": 0.0000,
            "tier": 1
          }
        ],
        "isExternalWithdrawEnabled": false,
        "isImmediateLoadFromLinkedAccountEnabled": true,
        "isInterestEnabled": false,
        "isRecurringContributionEnabled": true,
        "perTransactionDepositLimit": {
          "maximumAmount": 500.0,
          "minimumAmount": 1.0
        },
        "perTransactionWithdrawLimit": {
          "maximumAmount": 500.0,
          "minimumAmount": 1.0
        },
        "type": "Prepaid",
        "productId": 45
    }],
    "prepaidProducts": {
      "prepaid": {
        "balanceLimit": {
          "maximumAmount": 99999999.0,
          "minimumAmount": 0.0
        },
        "category": "Prepaid",
        "interestRates": [
          {
            "apr": 0.00000000000,
            "apy": 0.00000000000,
            "maximumAmount": 0.0000,
            "minimumAmount": 0.0000,
            "tier": 1
          }
        ],
        "isExternalWithdrawEnabled": false,
        "isImmediateLoadFromLinkedAccountEnabled": true,
        "isInterestEnabled": false,
        "isRecurringContributionEnabled": true,
        "perTransactionDepositLimit": {
          "maximumAmount": 500.0,
          "minimumAmount": 1.0
        },
        "perTransactionWithdrawLimit": {
          "maximumAmount": 500.0,
          "minimumAmount": 1.0
        },
        "type": "Prepaid",
        "productId": 45
      }
    },
    "savingsProducts": {},
    "timeZone": "Central Standard Time",
    "validAccountTypes": [
      "Prepaid"
    ],
    "verificationType": "None",
    "website": "https://coreproprepaid.corepro.io"
  },
  "errors": [],
  "requestId": "6e9d10e2-c2ca-456d-a2c1-29e92b0dcbf5",
  "status": 200
}

Ready to start a conversation?

Email Us