API Documentation
Payload Property Glossary
Each payload type can contain a different set of properties. See details for the definitions of all properties that appear in payloads.
Glossary Details
| Property Name | Meaning |
|---|---|
| amount | The amount of the transaction that caused this event. |
| approvedAmount | The amount of the mobile check deposit that was approved by the bank. Applicable only to mobile check deposit events. |
| approvedDate | The date the mobile check deposit was approved by the bank. Applicable only to mobile check deposit events. |
| 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:
|
| 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:
|
| 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. |
| checkAmount | The amount of the mobile check deposit that was submitted. Applicable only to mobile check deposit 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:
|
| 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:
|
| 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:
|
| receiptId | The unique identifier of a mobile check deposit record. Applicable only to mobile check deposit events. |
| rejectDate | The date the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events. |
| rejectReason | The reason the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events. |
| requestTypeCode |
The method of request from the debit rails. Possible values:
|
| 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. |
| submissionDate | The date the mobile check deposit was originally submitted by the customer. Applicable only to mobile check deposit events. |
| 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:
|
| terminalUnattendedTypeCode |
Possible values:
|
| 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 | |
| 300 | Program Account Deposit | |
| 302 | Program 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 | |
| 600 | Check Deposit Authorization | |
| 601 | Check Deposit | |
| 602 | Check Deposit Reversal | |
| 603 | Check Withdrawal | |
| 605 | Check Withdrawal Authorization | |
| 606 | Deposit Availability | |
| 607 | Digital Wallet Token | |
| 608 | Bank Hold |
Common Payload
The Common Payload (payloadTypeId = 1) is the common response that one will find off the AMQP service. All other payloads follow this exact same layout, and will populate the data property with 1 or more items in the list.
Possible Properties in data node
- accountId
- bankId
- cardId
- clientId
- contextId
- eventTimeUtc
- externalAccountId
- impactedCustomerId
- impactedUserId
- jobId
- payloadTypeId
- programId
- transactionId
- userEventId
- userEventTypeId
- userId
- version
Example Payload
TBD
Customer Account Deposit Payload
The Customer Account Deposit payload (payloadTypeId = 200) relates to any transaction that moved funds into the customer's account.
Possible Properties in data node
- amount
- availableDate
- comment
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- institutionName
- masterId
- modifiedById
- payloadTypeId
- returnCode
- settledDate
- subType
- subTypeCode
- tag
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Customer Account Transfer Payload
The Customer Account Transfer payload (payloadTypeId = 201) relates to any transaction that moved funds out of the customer's account and into another one of the same customer's accounts.
Possible Properties in data node
- amount
- availableDate
- comment
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- modifiedById
- payloadTypeId
- returnCode
- settledDate
- subType
- subTypeCode
- tag
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Customer Account Withdrawal Payload
The Customer Account Withdrawal payload (payloadTypeId = 202) payload relates to any transaction that moved funds out of the customer's account.
Possible Properties in data node
- amount
- availableDate
- comment
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- modifiedById
- payloadTypeId
- returnCode
- settledDate
- subType
- subTypeCode
- tag
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Program Account Deposit Payload
The Program Account Deposit payload (payloadTypeId = 300) relates to any transaction that moved funds into one of the program's accounts without touching any customer account.
Possible Properties in data node
- amount
- availableDate
- comment
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- institutionName
- masterId
- modifiedById
- payloadTypeId
- returnCode
- settledDate
- subType
- subTypeCode
- tag
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Program Account Withdrawal Payload
The Program Account Withdrawal payload (payloadTypeId = 302) payload relates to any transaction that moved funds into one of the program's accounts without touching any customer account.
Possible Properties in data node
- amount
- availableDate
- comment
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- modifiedById
- payloadTypeId
- returnCode
- settledDate
- subType
- subTypeCode
- tag
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Deposit Payload
The Debit Card Deposit payload (payloadTypeId = 400) relates to any debit card message that attempted to move funds into the customer's account.
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Transfer Payload
The Debit Card Transfer payload (payloadTypeId = 401) relates to any debit card message that attempted to move funds between two accounts tied to a given card and belonging to the same customer.
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Withdrawal Payload
The Debit Card Withdrawal payload (payloadTypeId = 402) relates to any debit card message that attempted to move funds out of the customer's account.
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Withdrawal Authorization Payload
The Debit Card Withdrawal Authorization payload (payloadTypeId = 403) relates to any debit card message that attempted to apply a hold on funds in the customer's account.
Possible Properties in data node
Example Payload
Debit Card Declined Payload
The Debit Card Declined payload (payloadTypeId = 410) relates to any debit card message that was declined, either by CorePro itself or another system between CorePro and the device accepting the card information from the end user.
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- denialReason
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Account Balance Inquiry Payload
The Debit Card Balance Inquiry payload (payloadTypeId = 490) relates to any debit card message that attempted to retrieve balance(s).
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Deposit Reversal Payload
The Debit Card Deposit Reversal payload (payloadTypeId = 500) relates to any debit card message that attempted to reverse the movement of funds into the customer's account.
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Transfer Reversal Payload
The Debit Card Transfer Reversal payload (payloadTypeId = 501) relates to any debit card message that attempted to reverse the movement of funds between two accounts tied to a given card and belonging to the same customer.
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Withdrawal Reversal Payload
The Debit Card Withdrawal Reversal payload (payloadTypeId = 502) relates to any debit card message that attempted to reverse the movement of funds out of the customer's account.
Possible Properties in data node
- amount
- availableDate
- authorizationTransactionId
- comment
- cardHolderPresenceTypeCode
- cardId
- cardPresenceTypeCode
- cashbackAmount
- cashDepositAmount
- checkDepositAmount
- createdDate
- customerId
- customField1
- description
- feeCode
- feeDescrition
- friendlyDescription
- institutionName
- masterId
- merchantCity
- merchantGroupTypeCode
- merchantCountryCode
- merchantId
- merchantLocation
- merchantStateCode
- merchantZipCode
- modifiedById
- networkProviderTypeId
- panEntryModeTypeCode
- payloadTypeId
- pinEntryModeTypeCode
- requestTypeCode
- returnCode
- settledDate
- subType
- subTypeCode
- surchargeAmount
- tag
- terminalId
- terminalPremisesTypeCode
- terminalUnattendedTypeCode
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Debit Card Withdrawal Authorization Reversal Payload
The Debit Card Withdrawal Authorization Reversal payload (payloadTypeId = 503) relates to any debit card message that attempted to reverse the application of hold on funds in the customer's account.
Possible Properties in data node
Example Payload
Check Deposit Authorization Payload
The Check Deposit Authorization payload (payloadTypeId = 600) relates to any mobile check deposit message that attempted to deposit funds in the customer's account.
Possible Properties in data node
Example Payload
Check Deposit Payload
The Check Deposit payload (payloadTypeId = 601) relates to any mobile check deposit message that was approved by the bank and deposited funds in the customer's account.
Possible Properties in data node
- amount
- approvedAmount
- approvedDate
- availableDate
- cardId
- checkAmount
- comment
- createdDate
- customerId
- customField1
- description
- friendlyDescription
- institutionName
- masterId
- modifiedById
- payloadTypeId
- receiptId
- settledDate
- submissionDate
- tag
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Check Deposit Reversal Payload
The Check Deposit Reversal payload (payloadTypeId = 602) relates to any mobile check deposit message that was reversed by the bank.
Possible Properties in data node
- amount
- availableDate
- cardId
- checkAmount
- comment
- createdDate
- customerId
- customField1
- description
- friendlyDescription
- institutionName
- masterId
- modifiedById
- payloadTypeId
- receiptId
- rejectDate
- rejectReason
- settledDate
- submissionDate
- tag
- toAccountAmount
- toAccountId
- toAccountNumberMasked
- toAvailableAmount
- toCategory
- toCreatedDate
- toCustomField1
- toCustomField2
- toCustomField3
- toCustomField4
- toCustomField5
- toLegalName1
- toLegalName2
- toName
- toPendingAmount
- toPrimaryCustomerId
- toSubCategory
- toTag
- toTargetAmount
- toTargetDate
- toTargetMetDate
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Check Withdrawal Payload
The Check Withdrawal payload (payloadTypeId = 603) relates to any check withdrawal message that was approved/processed by the bank and withdrawn funds from the customer's account.
Possible Properties in data node
- amount
- approvedAmount
- approvedDate
- availableDate
- cardId
- checkAmount
- comment
- createdDate
- customerId
- customField1
- description
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- modifiedById
- payloadTypeId
- receiptId
- settledDate
- submissionDate
- tag
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Check Withdrawal Authorization Payload
The Check Withdrawal Authorization payload (payloadTypeId = 605) relates to any check withdrawal message that attempted to withdraw funds from the customer's account.
Possible Properties in data node
Example Payload
Deposit Availability Payload
The Deposit Available payload (payloadTypeId = 606) relates to partial deposit becoming available.
Possible Properties in data node
- amount
- availableDate
- cardId
- checkAmount
- comment
- createdDate
- customerId
- customField1
- description
- friendlyDescription
- fromAccountAmount
- fromAccountId
- fromAccountNumberMasked
- fromAvailableAmount
- fromCategory
- fromCreatedDate
- fromCustomField1
- fromCustomField2
- fromCustomField3
- fromCustomField4
- fromCustomField5
- fromLegalName1
- fromLegalName2
- fromName
- fromPendingAmount
- fromPrimaryCustomerId
- fromSubCategory
- fromTag
- fromTargetAmount
- fromTargetDate
- fromTargetMetDate
- institutionName
- masterId
- modifiedById
- payloadTypeId
- receiptId
- settledDate
- submissionDate
- tag
- transactionId
- type
- typeCode
- version
- voidedDate
Example Payload
TBD
Digital Wallet Token Payload
The Digital Wallet Token payload (payloadTypeId = 607) relates to Digital Wallet Card Tokenization.
Possible Properties in data node
- accountNumberMasked
- accountId
- accountCategory
- accountSubCategory
- accountTag
- accountCustomField1
- accountCustomField2
- accountCustomField3
- accountCustomField4
- accountCustomField5
- accountCreatedDate
- accountTargetAmount
- accountTargetMetDate
- accountTargetDate
- accountLegalName1
- accountLegalName2
- accountName
- accountPrimaryCustomerId
- cardId
- customerTag
- customerId
- token
- tokenRequestorName
- tokenRequestorId
- PANReferenceId
- tokenReferenceId
- tokenType
- tokenStatus
- isDeviceProvisioned
- deviceType
- deviceLanguageCode
- deviceId
- deviceNumber
- deviceName
- deviceLocation
- deviceIpAddress
- WalletProviderRiskAssessmentType
- WalletProviderDeviceScore
- WalletProviderAccountScore
- WalletProviderReasonCodes
- PANSourceType
- WalletAccountId
- payloadTypeId
- version
Example Payload
TBD
Bank Hold Payload
The Bank Hold payload (payloadTypeId = 608) relates to Bank Holds when they are placed or released.
Possible Properties in data node
- customerId
- transactionId
- masterId
- accountId
- accountNumberMasked
- holdAmount
- holdPlacedDate
- holdExpirationDate
- holdReleasedDate
- description
- availableAmountBefore
- availableAmountAfter
- payloadTypeId
- version
Example Payload
TBD