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.
50902	ProgramId {0} does not have a BIN mapped to it.	400	Your program is configured incorrectly. Contact support@corepro.io
50904	Could not find PciKeyId for BankId {0}, ProgramId {1} in a status of 1 (Encrypt and Decrypt allowed).	400	Your program is configured incorrectly. Contact support@corepro.io
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.

Card Provision

Provision a card into a mobile wallet by initiating push provisioning from your app.

provisionApplePay

Get Apple Pay enrypted data for provisioning into Apple Pay Wallet.

POST /card/provision/applepay

Request Body Parameters

Property	Data Type	Description
`cardId`	integer	The unique identifier for a card.
`customerId`	integer	The unique identifier of the customer who actually created the card. This customer must have a `status` of `Verified` and have an `accessTypeCode` of `FULL`.
`certificates`	string[]	json string array of base 64 encoded Apple X.509 certificates (* returned by Apple)
`nonceBase64`	string	Base64 random number generated to avoid replay attacks (* returned by Apple)
`nonceSignatureBase64`	string	Base64 nonce signature (* returned by Apple)

Response Data

Property	Data Type	Description
`encryptedPassData`	string	Base64 encoded encrypted authentication data consisting of encrypted PAN, expiry date, name etc. This value should be passed through to Apple as is.
`activationData`	string	Base64 encoded activation data consisting of encrypted nonce, noncesignature, and authCode. This value should be passed through to Apple as is.
`ephemeralPublicKey`	string	Base64 encoded encrypted JSON containing the sensitive information needed to add a card to Apple Pay. This value should be passed through to Apple as is.

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
154101	Invalid CardId {0} or CustomerId {1} is not associated with the card.
157001	Apple Pay Mobile Wallet Card Provisioining Program setting is not turned on.
157004	Card is in {0} status and must be in Verified status for successful provisioning into a wallet.

Example

Request

POST /card/provision/applepay
Authorization: Basic PutBase64TokenHere

{
  "cardId": 9799889,
  "customerId": 9715554,
  "certificates": [
    "MIID/TCCA6OgAwIBAgIIMq/qUa9Z2nMwCgYIKoZIzj0EAwIwgYAxNDAyBgNVBAMMK0FamGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0gRzIxJjAkBgNV0AsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xODA2MDEyMjAzMTBaFw0yMDA2MzAyMjAzMTBaMGwxNTAzBgNVBAMMLGVjYy1jcnlwdG8tc2VydmljZXMtZW5jaXBoZXJtZW50X1VDNi1TQU5EQk9YMREwDwYDVQQLDAhBcHBsZVBheTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATGiJjmEMmvOZBGj+tdj2ED7xnc9y1C0vNVaqZva7lvKkbgrfcWdo0/NdIJZ5wDcZ0eBtPuRJ+q/eSP9FLXQ19wo4ICGDCCAhQwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSEtoTMOoZichZZlOgao71I3zrfCzBHBggrBgEFBQcBAQQ7MDkwNwYIKwYBBQUHMAGGK2h0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDMtYXBwbGV3d2RyY2EyMDUwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxld3dkcmNhMi5jcmwwHQYDVR0OBBYEFMNruSHk5gH1LauD+wBI/9sgl/VpMA4GA1UdDwEB/wQEAwIDKDASBgkqhkiG92NkBicBAf8EAgUAMAoGCCqGSM49BAMCA0gAMEUCIQDhL+sL9bcrvAVO3UvswA805EHujfL7iVDrbEuJfOSJoAIgBPKehtuILl9x/SJ5kxReiml1zkJqUB8nTy0UOfUNIIQ="
  ],
  "nonceBase64": "kauVuA==",
  "nonceSignatureBase64": "QHuLYArUCO2OZevP0rHc99g9RJp4O1dgsZuVpUdlA7zPWqCDhVQo9Mxr1uPS6GVyjZYo3YElIhHRV4Mv3wEJ3hGOaxK1gResup88QWDK1fL0"
}

Response

{
  "data": {
    "activationData": "TUJQQUMtMS1GSy00NzYxMjYuMS0tVERFQS04M0Y0RkE4QUJBQjYwNThDNTQ3MTA5NUM4M0Q5MkNEREY3QTA1NzM2Q0M0OUNGOEFCOTJBMTlGNEIzRUZBNjBDQkZERUY3MDdDRkNCMEQyMg==",
    "encryptedPassData": "ckYT6PBF1EfJrebdbAx98dIEz+M73CV7uG38OcEMHIkirCVaYpilBWPCMRHAzHPMP4fYPGgP4eDzaPrnjAse8UZM8pd3FPm906Dcp7cliNxb9bdPm5H1ywZHMzrvHyfY23zeIsQHhzjdlD1OFQ+76/AO6ZG5w5LyOt8D1P/26HuRWluZ4NIDweky/IDX51YH4PDH12j4h3TWleoDxA9OXr7L3Hwnk+wHWnZ8SMJ5GQcQHoQl1pR1anPdpuduG+HJcemCJXtW3tFQhQgKI1Qx8M4DWiFKvlZDgZ8rx0vp04QoXKWlhhzm07GYXhYfbEmYujtCXJyBYYdZufkzwC8hmZbgCpcAcGZel+tpkv7I4beuF2iR4YpEL04IwunaDbaGxDP87Ts4ARu/EoRyZAfgCBa363SSEyLWzaAxxbn0bFRBTMRXttrNyT3q6bsrSKL9AWaM7pm5lQYKlR/ocPvAPFbt+KQazPVa4kdsj18t/RLw3lsY2lJyWrfsTOMJBYKYzENIfYV0XYgudkXY86ka3CG9/nSVT+auWYSQCFiEOGKOzJuAH+S2rD5cXK1QWwpscBLquRc7TBs5dYGOGXvxeuf9CTxFkyRdnveO6VzNvQgmGY7CUlf1AmLuQ/oOZ49XVT327M9YjjeWozZo40YKo+9Ll+vAhd+uruBwzGRi4myQk1smP/9PfpJSI0xWW8ZhqBKqoVnuzdMJgQRz8w==",
    "ephemeralPublicKey": "BD4XRmMyWxHV4JO+TJswdg8lC8hXzxczGT0o2k27bDZW3phJHOybEE3wvRCR4V1hi15rTjlsIhrSnHqHssRn7H4="
  },
  "errors": [],
  "requestId": "d2aa0961-438e-48c4-b04f-b153312bc024",
  "status": 200
}

provisionGooglePay

Get Google Pay enrypted data for provisioning into Google Pay Wallet.

POST /card/provision/googlepay

Request Body Parameters

Property	Data Type	Description
`cardId`	integer	The unique identifier for a card.
`customerId`	integer	The unique identifier of the customer who actually created the card. This customer must have a `status` of `Verified` and have an `accessTypeCode` of `FULL`.
`deviceId`	string	User’s Android Device ID, the device’s unique identifier.
`clientCustomerId`	string	User’s Wallet account ID from Google Pay SDK.

Response Data

Property	Data Type	Description
`address`	`address` Object	Customer `Residence` address.
`last4`	string	Last 4 digits of the PAN.
`opaquePaymentCard`	string	Base64 encoded opaque card data that is needed by the client for tokenization. This value should be passed through to Google as is.

Error Codes

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
154101	Invalid CardId {0} or CustomerId {1} is not associated with the card.
157002	Google Pay Mobile Wallet Card Provisioining Program setting is not turned on.
157004	Card is in {0} status and must be in Verified status for successful provisioning into a wallet.

Example

Request

POST /card/provision/googlepay
Authorization: Basic PutBase64TokenHere

{
  "cardId": 492296,
  "customerId": 9715554,
  "deviceId": "uztEQocBRFrbK5hCgcDbxqw_",
  "clientCustomerId": "bogus_sandbox_value"
}

Response

{
    "data": {
        "address": {
            "addressLine1": "222333 Peachtree Place",
            "addressLine2": "",
            "addressLine3": "",
            "addressLine4": "",
            "addressType": "Residence",
            "city": "Atlanta",
            "country": "US",
            "isActive": true,
            "postalCode": "30318",
            "state": "GA"
        },
        "last4": "0292",
        "opaquePaymentCard": "eyJhdWQiOiIxODk5NzZhNi0yZmFjLTRlZDEtOTM0ZS03MjY5NmVhMDgxMzEiLCJraWQiOiI4VUlDVlI2T05OSVZUVldJUVE0QzIxcmh2N2VOa2ZDajhiN1FVOG5DZThOZEV2X2t3IiwiaXNzIjoiYTVhMGQzODUtNGExZC0xZDU2LTE4NWYtMTU5ZjE3ODdhMjAxIiwidHlwIjoiSk9TRSIsImNoYW5uZWxTZWN1cml0eUNvbnRleHQiOiJTSEFSRURfU0VDUkVUIiwiZW5jIjoiQTI1NkdDTSIsInRhZyI6Il82Q3VfUEdZNHc3ZUg4LTdqc3VEZWciLCJpYXQiOjE2MDc5NTY0NjQsImFsZyI6IkEyNTZHQ01LVyIsIml2IjoiTjE5NHJjbE5mcng3dlRHSiJ9.Lpr69Vp2bu9sxiLtW-MEJJyo3GLagazsl4e4rWzCJYA.N1SwSFq6-ey4rFnr.fQOgrFoEC2vagJ5hjWAdi7azy1JXTOhHBrZWiqFYiyfO3Ot2klffWY4forYgBIt-j1138JQVtrTb49KoXljQ0_Rll00T9AFIrUlpRfnrcISRMA0LhACM_vCB_7I0CYMQwPdqIY7OYjn3EhKKk0fdHuhIYNjWFwZ3V4w0QdqHdt4igFowSnTbr5GAtQ3B2Cs1UOKlSd3Znffm_-VNpbSRnAdGcQoJ6EWzZApTpmzDyZndxh_RE27XU6Dnovnqc6TRiAvrHMgUG5p2Tkf4t_YhXDMFA66p16bIK09kSU7sZZ31VK4prS1IyFdtYeGPhc45Mbq4yMyvJenGC2iLrafs2I1IRWUe1Q-Vp6VNaR4pLBfthXeKFhkdypVQtcZzrcCxW_EXiEzTp0axql1wqheJKIDGWvb6NiQavl6sllXP7jVtW2r5Ko0pqXuq76nPsXJdVGtRovFIpahQn2i4odNf6BvHCfUaIentxtFyai0RuOZ3ry9Gqa7lLC8HfaPhnXO07C2pU0hz14oGEDKk7Vn-sVGYyFeISI5OHcvAQqDJsYlawThm62i7vuZ-yz7ycaYR8RM.FOODOuA0cNMXMZs7eyX64w"
    },
    "errors": [],
    "requestId": "32693c93-d832-4138-856a-a14cd7260831",
    "status": 200
}

API Documentation

Common Error Codes

details

Card Provision

provisionApplePay

POST /card/provision/applepay

Request Body Parameters

Response Data

Error Codes

Example

Request

Response

provisionGooglePay

POST /card/provision/googlepay

Request Body Parameters

Response Data

Error Codes

Example

Request

Response

Ready to start a conversation?