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:
|
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. |
bin |
A list of bin objects |
The bins configured for your program. Please contact support to modify existing bins or add new ones. |
checkingProducts |
A dictionary with a single product object |
Deprecated; Filter by The original product with |
prepaidProducts |
A dictionary with a single product object |
Deprecated; Filter by The original product with |
savingsProducts |
A dictionary with a single product object |
Deprecated; BFilter by The original product with |
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.
|
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
"data": { "accounts": [ { "accountBalance": 0.0, "accountId": 240717, "accountNumber": "EX3-FAKE", "accountNumberMasked": "*************FAKE", "description": "Account used for BillPay", "isActive": true, "programAccountId": 240717, "type": "ProgramClearingAccount" }, { "accountBalance": -5000.0, "accountId": 240718, "accountNumber": "EX3-PGMRSV", "accountNumberMasked": "*************MRSV", "description": "Account for giving reward funds to customers", "isActive": true, "programAccountId": 240718, "type": "ProgramReserve" }, { "accountBalance": 0.0, "accountId": 242353, "accountNumber": "217204", "accountNumberMasked": "*************7204", "description": "", "isActive": true, "programAccountId": 242353, "type": "InterestExpense" }, { "accountBalance": 0.0, "accountId": 242357, "accountNumber": "217220", "accountNumberMasked": "*************7220", "description": "", "isActive": true, "programAccountId": 242357, "type": "InterestAccrual" }, { "accountBalance": 0.0, "accountId": 242366, "accountNumber": "217257", "accountNumberMasked": "*************7257", "description": "", "isActive": true, "programAccountId": 242366, "type": "BackupWithholdingAccount" }, { "accountBalance": 0.0, "accountId": 458101, "accountNumber": "400363", "accountNumberMasked": "*************0363", "description": "Debit card settlement account", "isActive": true, "programAccountId": 458101, "type": "CardSettlement" } ], "bank": { "maintenanceEndDate": "2000-01-01T00:00:00.000+00:00", "maintenanceStartDate": "2000-01-01T00:00:00.000+00:00", "name": "Fake Bank", "phone": "800-555-5555", "timeZone": "Central Standard Time", "webUrl": "http://www.example.com" }, "checkingProducts": { "checking": { "balanceLimit": { "maximumAmount": 250000.0 }, "category": "Checking", "interestRates": [], "isExternalWithdrawEnabled": true, "isRecurringContributionEnabled": true, "perTransactionDepositLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "perTransactionWithdrawLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "productId": 348745, "type": "Checking" }, "forBenefitOf": { "balanceLimit": { "maximumAmount": 250000.0 }, "category": "Checking", "interestRates": [], "isRecurringContributionEnabled": true, "perTransactionDepositLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "perTransactionWithdrawLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "productId": 348746, "type": "ForBenefitOf" } }, "decimalCount": 2, "eCodeProducts": {}, "externalAccounts": [ { "accountNumber": "000000000", "accountNumberMasked": "*************0000", "description": "N/A", "externalAccountId": 240719, "isActive": true, "nachaName": "EX3-FAKE", "programExternalAccountId": 240719, "routingNumber": "000000000", "type": "VerificationFund" }, { "accountNumber": "N/A", "accountNumberMasked": "**************N/A", "description": "N/A", "externalAccountId": 240720, "isActive": true, "nachaName": "EX3-FAKE", "programExternalAccountId": 240720, "routingNumber": "N/A", "type": "InterestFund" }, { "accountNumber": "N/A", "accountNumberMasked": "**************N/A", "description": "N/A", "externalAccountId": 240721, "isActive": true, "nachaName": "EX3-FAKE", "programExternalAccountId": 240721, "routingNumber": "N/A", "type": "BackupWithholdingAccount" }, { "accountNumber": "000000000", "accountNumberMasked": "*************0000", "description": "N/A", "externalAccountId": 240722, "isActive": true, "nachaName": "EX3-FAKE", "programExternalAccountId": 240722, "routingNumber": "000000000", "type": "Miscellaneous" }, { "accountNumber": "000000000", "accountNumberMasked": "*************0000", "description": "N/A", "externalAccountId": 240723, "isActive": true, "nachaName": "EX3-FAKE", "programExternalAccountId": 240723, "routingNumber": "000000000", "type": "BankIncomeAccount" }, { "accountNumber": "000012348", "accountNumberMasked": "*************2348", "description": "N/A", "externalAccountId": 240724, "isActive": true, "nachaName": "EX3-FAKE-PEA", "programExternalAccountId": 240724, "routingNumber": "000000000", "type": "ProgramExternalAccount" }, { "accountNumber": "123456789", "accountNumberMasked": "*************6789", "description": "test", "externalAccountId": 619447, "isActive": true, "nachaName": "", "programExternalAccountId": 619447, "routingNumber": "123456789", "type": "ProgramExternalAccount" } ], "filledDate": "2019-03-07T15:36:35.462+00:00", "isDebitRewardsEnabled": false, "isInternalToInternalTransferEnabled": true, "name": "Example3", "perProgramDailyDepositLimit": { "maximumAmount": 999999999.99 }, "perProgramDailyWithdrawLimit": { "maximumAmount": 999999999.99 }, "perUserAccountCountMax": 50, "perUserDailyDepositLimit": { "maximumAmount": 5000.0 }, "perUserDailyWithdrawLimit": { "maximumAmount": 5000.0 }, "perUserExternalAccountCountMax": 1, "perUserMonthlyDepositLimit": { "maximumAmount": 50000.0 }, "perUserMonthlyWithdrawLimit": { "maximumAmount": 50000.0 }, "perUserTotalAccountBalanceMax": 250000.0, "prepaidProducts": {}, "products": [ { "balanceLimit": { "maximumAmount": 250000.0 }, "category": "Savings", "description": "", "interestRates": [ { "apr": 0.01000000000, "apy": 0.01005002862, "description": "Tier 1", "effectiveDate": "2018-12-06T09:26:00.498-06:00", "maximumAmount": 9220060039788.5600, "minimumAmount": 0.0000, "productId": 348782, "rateEffectiveDate": "2018-11-01T00:00:00.000-05:00", "tier": 1 } ], "isExternalWithdrawEnabled": true, "isInterestEnabled": true, "isRecurringContributionEnabled": true, "name": "Savings", "perMonthRegDTransactionCountMaximum": 8, "perMonthRegDTransactionCountWithoutFee": 6, "perTransactionDepositLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "perTransactionWithdrawLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "productId": 348782, "type": "Savings" }, { "balanceLimit": { "maximumAmount": 250000.0 }, "category": "Checking", "interestRates": [], "isExternalWithdrawEnabled": true, "isRecurringContributionEnabled": true, "perTransactionDepositLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "perTransactionWithdrawLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "productId": 348745, "type": "Checking" }, { "balanceLimit": { "maximumAmount": 250000.0 }, "category": "Checking", "interestRates": [], "isRecurringContributionEnabled": true, "perTransactionDepositLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "perTransactionWithdrawLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "productId": 348746, "type": "ForBenefitOf" } ], "publicKeyAlgorithms": "RSA-OAEP-SHA512-MGF1, RSA-OAEP-SHA256-MGF1, RSA-OAEP-SHA1-MGF1, NONE", "savingsProducts": { "savings": { "balanceLimit": { "maximumAmount": 250000.0 }, "category": "Savings", "description": "", "interestRates": [ { "apr": 0.01000000000, "apy": 0.01005002862, "description": "Tier 1", "effectiveDate": "2018-12-06T09:26:00.498-06:00", "maximumAmount": 9220060039788.5600, "minimumAmount": 0.0000, "productId": 348782, "rateEffectiveDate": "2018-11-01T00:00:00.000-05:00", "tier": 1 } ], "isExternalWithdrawEnabled": true, "isInterestEnabled": true, "isRecurringContributionEnabled": true, "name": "Savings", "perMonthRegDTransactionCountMaximum": 8, "perMonthRegDTransactionCountWithoutFee": 6, "perTransactionDepositLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "perTransactionWithdrawLimit": { "maximumAmount": 5000.0, "minimumAmount": 1.0 }, "productId": 348782, "type": "Savings" } }, "timeZone": "Central Standard Time", "validAccountTypes": [ "Savings", "Checking", "ForBenefitOf" ], "validProductTypes": [ "Savings", "Checking", "ForBenefitOf" ], "verificationType": "Full", "website": "http://www.example.com" }, "errors": [], "requestId": "fc8d3148-e362-43f1-af8a-62abe3603549", "status": 200 }