API Documentation

Payload Property Glossary

Each payload type can contain a different set of properties. See details for the defintions of all properties that appear in payloads.

Glossary Details

Property Name	Meaning
amount	The amount of the transaction that caused this event.
availableDate	The date the funds associated with the transaction were applied to the `availableAmount` and therefore made available for withdrawal.
authorizationTransactionId	The `transactionId` of the authorization that this transaction completed.
cardHolderPresenceTypeCode	The presence of the card holder at the time the transaction was originated. Possible values: `INSTALL` - Cardholder not present, installment payment `MAILTEL` - Cardholder not present, mail or telephone order `MOBILE` - Mobile `NOTPRESENT` - Cardholder not present, unspecified `PRESENT` - Cardholder present `RECUR` - Cardholder not present, recurring payment `TRANSFER` - Money Transfer `UNKNOWN` - Unknown `WEB` - Web
cardId	The card associated with the transaction. Applicable only to debit card events.
cardPresenceTypeCode	The presence of the physical card at the time the transaction was originated. Possible values: `NOTPRESENT` - Card not present `PRESENT` - Card present
cashbackAmount	The amount of cash the end user received during a debit card withdrawal at a non-ATM device. Applicable only to debit card events.
cashDepositAmount	The amount of cash deposited by the transaction. Applicable only to debit card events.
checkDepositAmount	The amount of the check deposited by the transaction. Applicable only to debit card events.
comment	A notation applied by CorePro employees internally containing any special extra information about the transaction. Very rare.
customerId	The unique identifier for the customer in CorePro that caused this event.
createdDate	The date the transaction was first created in CorePro.
customField1	A caller-specified, freeform value assigned to this particular transaction.
denialReason	Text describing why a transaction was denied from taking place. Applicable only to debit card events.
description	A caller-specified description of the transaction that caused this event. Will be automatically filled with relevant data if transaction resulted from ACH or debit card activity.
feeCode	The programmatic value for the type of fee this transaction represents. Possible values: `RGD` - Regulation D Fee `RTN` - Return Item Fee `NSF` - Insufficient Funds Fee
feeDescription	A human-readable description of the `feeCode`.
friendlyDescription	A human-readable, automatically generated description of the transaction that caused the event. Driven by the `typeCode` of the transaction.
fromAccountId	The unique identifier for the customer account that was debited.
fromAccountAmount	Total balance of the customer account that was debited, after the debit was applied, including funds that have holds placed on them. Represents all settled transactions to date.
fromAccountNumberMasked	Masked version of the Account number of the customer account that was debited. e.g. ********1234
fromAvailableAmount	Balance available for immediate withdrawal from the customer account that was debited after the debit was applied.
fromCategory	The caller-specified category to which the customer account that was debited belongs.
fromCreatedDate	Date the customer account was created.
fromCustomField1	A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField2	A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField3	A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField4	A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField5	A caller-specified, freeform value assigned to the customer account that was debited.
fromLegalName1	The first legal name used to identify the customer account that was debited.
fromLegalName2	The second legal name used to identify the customer account that was debited.
fromName	A caller-specified, user-friendly name for the customer account that was debited.
fromPendingAmount	Balance of pending deposit transactions on the customer account that was debited, after the debit was applied.
fromPrimaryCustomerId	Denotes the customer considered the primary owner for the account that was debited.
fromSubCategory	The caller-specified subcategory to which the customer account that was debited belongs.
fromTag	A caller-specified, unique identifier for the customer account that was debited.
fromTargetAmount	The amount the customer wants the fromAvailableAmount to reach on the account that was debited.
fromTargetDate	The date the customer would like the fromTargetAmount to be reached on the account that was debited.
fromTargetMetDate	The first date the availableAmount reached or exceeded the fromTargetAmount on the account that was debited.
institutionName	The name of the institution from which the transaction originated. Rarely contains data.
masterId	The unique identifier created by CorePro used to group related transactions together that caused this event.
merchantGroupTypeCode	A grouping of multiple Merchant Category Codes into fewer, more useful sets. Applicable only to debit card events. See Merchant Group Types for more information.
merchantCity	The city of the merchant at which the transaction originated. Applicable only to debit card events.
merchantCountryCode	The two-character country abbreviation of the merchant at which the transaction originated. Applicable only to debit card events.
merchantId	The identification code of the merchant that accepted the card information. Applicable only to debit card events.
merchantLocation	The location of the merchant at which the transaction originated. Applicable only to debit card events.
merchantStateCode	The two-character state abbreviation of the merchant at which the transaction originated. Applicable only to debit card events.
merchantZipCode	The postal code of the merchant at which the transaction originated. Applicable only to debit card events.
modifiedById	The `customerId` or the Admin `userId` that last modified the transaction.
panEntryModeTypeCode	The method by which the card number was input to the merchant's device. Possible values: `KEY` - Manually (key) entered `MAG` - Magnetic stripe read `MAN` - Manual, no terminal `UNK` - Unknown
payloadTypeId	The "type" of payload in the `data` node. Represents a predefined set of properties that could potentially appear in the `data` node. (properties with null values for a particular instance of the payload will be excluded)
pinEntryModeTypeCode	The method by which the card holder was validated at the merchant's device. Possible values: `N/A` - Not Applicable `PIN` - Network Provider-verified PIN `PWD` - Password authentication
requestTypeCode	The method of request from the debit rails. Possible values: `REQ` - Request; CorePro approved or denied the message. `ADV` - Advice; The network provider approved or denied the message and notified CorePro afterwards.
returnCode	The ACH-specified return code applied to the transaction.
settledDate	The date the funds associated with the transaction were applied to the `accountAmount` for the corresponding account. Note this does not imply the funds are available for withdrawal yet.
subType	A human-readable description of the subcatgorization of the `type`. For debit card transactions, this is the description of the Merchant Category Code value represented in the `subTypeCode`. See Merchant Category Codes for more information.
subTypeCode	A programmatic subcategorization of the `typeCode`. For debit card transactions, this is the exact Merchant Category Code value received from the network provider. See Merchant Category Codes for more information.
surchargeAmount	The amount of surcharge applied to the tranasaction amount. For instance, if the `amount` property contains `202.50` and the `surchargeAmount` contains `2.50`, the user actually received `200.00`. Applicable only to debit card events.
tag	A caller-specified unique value to represent the transaction that caused this event.
terminalId	The identification code of the device at the merchant that accepted the card information. Applicable only to debit card events.
terminalPremisesTypeCode	Location of the merchant's device in relation to the merchant's location. Possible values: `ECOMM` - Electronic Commerce `OFFPREM` - Off premise `ONPREM` - On premise
terminalUnattendedTypeCode	Possible values: `ATTENDED` - Terminal was attended `NOTERM` - No terminal `UNATTENDED` - Terminal was unattended
toAccountAmount	Total balance of the customer account that was credited, after the credit was applied, including funds that have holds placed on them. Represents all settled transactions to date.
toAccountId	The unique identifier for the customer account that was credited.
toAccountNumberMasked	Masked version of the Account number of the customer account that was credited. e.g. ********1234
toAvailableAmount	Balance available for immediate withdrawal from the customer account that was credited after the credit was applied.
toCategory	The caller-specified category to which the customer account that was credited belongs.
toCreatedDate	Date the customer account was created.
toCustomField1	A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField2	A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField3	A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField4	A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField5	A caller-specified, freeform value assigned to the customer account that was credited.
toLegalName1	The first legal name used to identify the customer account that was credited.
toLegalName2	The second legal name used to identify the customer account that was credited.
toName	A caller-specified, user-friendly name for the customer account that was credited.
toPendingAmount	Balance of pending deposit transactions on the customer account that was credited, after the credit was applied.
toPrimaryCustomerId	Denotes the customer considered the primary owner for the account that was credited.
toSubCategory	The caller-specified subcategory to which the customer account that was credited belongs.
toTag	A caller-specified, unique identifier for the customer account that was credited.
toTargetAmount	The amount the customer wants the toAvailableAmount to reach on the account that was credited.
toTargetDate	The date the customer would like the toTargetAmount to be reached on the account that was credited.
toTargetMetDate	The first date the availableAmount reached or exceeded the targetAmount on the account that was credited.
transactionId	The unique identifier created by CorePro for the particular transaction that caused this event.
type	A human-readable representation of the type of transaction that caused this event.
typeCode	Programmatic value for the type of transaction that caused this event. See the Transaction object definition `typeCode` property for possible values.
version	The version of the payload in the `data` node.
voidedDate	The date the transaction was voided in CorePro.

Payload Types

There are various types of payloads that can appear in the data node for an event body.

Payload Type Id	Description	Detail
1	Common Payload
200	Customer Account Deposit
201	Customer Account Transfer
202	Customer Account Withdrawal
400	Debit Card Deposit
401	Debit Card Transfer
402	Debit Card Withdrawal
403	Debit Card Withdrawal Authorization
410	Debit Card Declined
490	Debit Card Balance Inquiry
500	Debit Card Deposit Reversal
501	Debit Card Transfer Reversal
502	Debit Card Withdrawal Reversal
503	Debit Card Withdrawal Authorization Reversal

Common Payload

The Common Payload (payloadTypeId = 1) is the common response that one will find off the AMQP service. This JSON response is nested in the jsonData property off the brokered message. All other payloads follow this exact same layout, but will populate the data property with 1 or more items in the list.

API Documentation

Payload Property Glossary

Payload Types

Common Payload

Example Payload

Customer Account Deposit Payload

Example Payload

Customer Account Transfer Payload

Example Payload

Customer Account Withdrawal Payload

Example Payload

Program Account Deposit Payload

Example Payload

Program Account Withdrawal Payload

Example Payload

Debit Card Deposit Payload

Example Payload

Debit Card Transfer Payload

Example Payload

Debit Card Withdrawal Payload

Example Payload

Debit Card Withdrawal Authorization Payload

Example Payload

Debit Card Declined Payload

Example Payload

Debit Card Account Balance Inquiry Payload

Example Payload

Debit Card Deposit Reversal Payload

Example Payload

Debit Card Transfer Reversal Payload

Example Payload

Debit Card Withdrawal Reversal Payload

Example Payload

Debit Card Withdrawal Authorization Reversal Payload

Example Payload

Ready to start a conversation?