Category links

API Links

CheckPayment

Action: POST

Endpoint: /api/WebHookNotification/UpdateNotification/CheckPayment

This webhook is triggered when a check payment is processed on an account. 1.0 1.0 2.0 Neerja Agrawal Initial Release 10/12/2021

Request fields details
Fields Description

MonetaryLog

Group element will always null for collection

Category

string

Category

CategoryName

string

Indicates category of alert triggered Possible values: Account Creation, Payment Schedule, Manage Bank Account, Create Secondary card, Card Replacement, Customer Information, Update Credit Limit, Update Manual Status, Loyalty Redemption, Loyalty Manual Redemption, Loyalty Points Adjustments, Card Activation, CollateralID, Update System Status, Update Card Status, Card Auto Reissue, Dispute Release OTB, PromotionalReward

Allowable Values:

40

CategoryID

integer

Numeric unique identifier for Category

CategoryFieldList

array

Array of fields passed in webhook

ModifiedFieldName

string

Field name for which value is updated. This tag will always be followed with tags ‘OldValue’ and ‘NewValue’. Valid list of fields under this tag is available at end of document.

Allowable Values:

40

OldValue

string

Previous value for field being updated. For Insert, it will be null. Applicable for Update

Allowable Values:

40

NewValue

string

Updated value by which field is updated

Allowable Values:

40

ChangeStatusFor

string

ChangeStatusFor

CurrentManualStatus

string

Current manual status of account

CurrentGeneratedStatus

string

Current system-generated status of account

DerivedPartnerStatus

string

DerivedPartnerStatus

ManualStatusListOld

string

ManualStatusListOld

ManualStatusListNew

string

ManualStatusListNew

CardnumLast4Digits

string

Last 4 digits of card number

SubCategory

string

Category

TranId

int64

Transaction ID, a unique identifier for transaction which is available on panel in CoreCredit

TransactionAmount

decimal

Amount for which transaction occurred

TransactionDateTime

DateTime

Will show date time when transaction was posted

CurrentBalanceAfterTran

decimal

Updated Current Balance on account after recent transaction

AuthTranId

int64

A unique identifier value for authorization transaction

RecoveredRewardPoints

decimal

Indicates number of rewards points earned on the transaction

CheckNumber

string

Indicates type of balance which is getting impacted by this transaction Valid Values:Chargeoff Balance,Active Balance(current balance)

BalanceIndicator

string

Allowable Values:

20

BankAccountLast4Digit

string

Last 4 digits of bank account number. Valid Values:0-9

Allowable Values:

4

CardnumLast4Digits

string

Last 4 digits of card number. Valid Values:0-9

Allowable Values:

4

InstallmentsBalance

decimal

Current unpaid balance of all installment plans on the account

InstallmentsPendingPurchases

decimal

Sum of all installment purchases that are in confirmed state and holding OTB (e.g. an auth), but are not yet active (e.g. posted)

StatementRemainingBalanceWithInstallmentDue

decimal

The remaining amount a customer needs to pay to remain or become a transactor (open loop balance - installment plan min due amount) – any payments

AdjustedCurrentBalance

decimal

RevolvingCurrentBalance

decimal

InfoPlan

string

OriginalTranID

int64

TransactionReferenceID

int64

AccountNumber

string

Card Holder Account Number Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037

Allowable Values:

19

AdminNumber

string

Card Holder Admin Number Valid Values:0-9 Format:XXXXX Example:12345

RequestID

string

Primary Key for API Format:XXXXXXXXXXXXXXXX Example:12345

Allowable Values:

19

Mode

string

Valid Values::(a)Insert (b)Update

Allowable Values:

10

AccountUniversalUniqueId

string

Universal Unique Id For Account

Allowable Values:

64

CardUniversalUniqueId

string

Universal Unique Id For Card

Allowable Values:

64

ClientId

string

Corecard's Client Id or PersonId

Allowable Values:

64

RequestUniversalUniqueID

string

UniversalUniqueID Request

Allowable Values:

64

UpdateCallList

array

Group element will always null for collection

Category

Group of fields passed in webhook

CategoryName

string

Indicates category of alert triggered Possible values: Account Creation, Payment Schedule, Manage Bank Account, Create Secondary card, Card Replacement, Customer Information, Update Credit Limit, Update Manual Status, Loyalty Redemption, Loyalty Manual Redemption, Loyalty Points Adjustments, Card Activation, CollateralID, Update System Status, Update Card Status, Card Auto Reissue, Dispute Release OTB, PromotionalReward

Allowable Values:

40

CategoryID

integer

Numeric unique identifier for Category

CategoryFieldList

array

Array of fields passed in webhook

ModifiedFieldName

string

Field name for which value is updated. This tag will always be followed with tags ‘OldValue’ and ‘NewValue’. Valid list of fields under this tag is available at end of document.

Allowable Values:

40

OldValue

string

Previous value for field being updated. For Insert, it will be null. Applicable for Update

Allowable Values:

40

NewValue

string

Updated value by which field is updated

Allowable Values:

40

ChangeStatusFor

string

ChangeStatusFor

CurrentManualStatus

string

Current manual status of account

CurrentGeneratedStatus

string

Current system-generated status of account

DerivedPartnerStatus

string

DerivedPartnerStatus

ManualStatusListOld

string

ManualStatusListOld

ManualStatusListNew

string

ManualStatusListNew

CardnumLast4Digits

string

Last 4 digits of card number

AlertInfo

RewardsRedemption

Group element will always null for collection

Tab

string

Tab Valid Values: Monetary

Allowable Values:

10

Category

string

Category Valid Values: Reward

Allowable Values:

70

CategoryName

string

Indicates category of alert triggered Possible values: Account Creation, Payment Schedule, Manage Bank Account, Create Secondary card, Card Replacement, Customer Information, Update Credit Limit, Update Manual Status, Loyalty Redemption, Loyalty Manual Redemption, Loyalty Points Adjustments, Card Activation, CollateralID, Update System Status, Update Card Status, Card Auto Reissue, Dispute Release OTB, PromotionalReward

Allowable Values:

40

CategoryID

integer

Numeric unique identifier for Category

CategoryFieldList

array

Array of fields passed in webhook

ModifiedFieldName

string

Field name for which value is updated. This tag will always be followed with tags ‘OldValue’ and ‘NewValue’. Valid list of fields under this tag is available at end of document.

Allowable Values:

40

OldValue

string

Previous value for field being updated. For Insert, it will be null. Applicable for Update

Allowable Values:

40

NewValue

string

Updated value by which field is updated

Allowable Values:

40

ChangeStatusFor

string

ChangeStatusFor

CurrentManualStatus

string

Current manual status of account

CurrentGeneratedStatus

string

Current system-generated status of account

DerivedPartnerStatus

string

DerivedPartnerStatus

ManualStatusListOld

string

ManualStatusListOld

ManualStatusListNew

string

ManualStatusListNew

CardnumLast4Digits

string

Last 4 digits of card number

SubCategory

string

SubCategory Valid Values: Redemption,Delete,Write off,Abandon,Recovery,Write Off And Recovery,Reduced

Allowable Values:

70

TranID

decimal

TranID

LoyalityTranID

decimal

Loyality TranID

ClientUniqueID

string

ClientUniqueID

RedemptionMethod

string

Redemption Method

Allowable Values:

50

RedemptionCurrency

string

Redemption Currency (like USD)

Allowable Values:

3

Status

string

Redemption Status

Allowable Values:

20

PostTime

datetime

Redemption Transaction PostTime MM/DD/YYYY hh:mm:ss:nnn ET(24 hour Format)

RedemptionType

string

Redemption Type

Allowable Values:

30

RedemptionAmount

decimal

Redemption Amount

RedemptionPoints

integer

Redemption Points

ResponseErrorCode

string

Redemption Response Error Code In case of MM

Allowable Values:

50

ExternalErrorMessage

string

Redemption Response MMS API

Allowable Values:

50

ReferenceTransactionID

string

ReferenceID

Allowable Values:

100

RewardType

string

Generic/Individual

Allowable Values:

20

Reward

Group element will always null for collection

InfoReward

InfoCollectionAlert

Group of fields passed in webhook

InfoAgeOffAlert

User

string

User

Allowable Values:

40

DateandTime

DateTime

DateandTime Format:YYYY-MM-DD hh:mm:ss:nnn

Source

string

Source

Allowable Values:

20

ServiceName

string

ServiceName

Allowable Values:

40

AlertType

string

AlertType

Allowable Values:

100

TransactionSource

string

Transaction Source of transaction Valid Values:IPM, Retail Manual Auth-Installment, Retail Manual Auth-Revolver etc.

Allowable Values:

40

InstitutionID

integer

A unique identifier assigned by Corecard for Institution

ProductID

integer

A unique identifier assigned by Corecard for Product

AlertRecipientType

integer

Type of recipient to which alert needs to be sent Valid Values:1=Primary Applicant,2=Cosigner,3=Applicant and Cosigner,4=Auth User,5=Applicant and Auth User

InfoAlert

Group of fields passed in webhook

Sample request body
{
  "MonetaryLog": {
    "Category": "Monetary",
    "SubCategory": null,
    "TranId": 1166971407,
    "TransactionType": 21,
    "TransactionCode": 37022,
    "TransactionDescription": "37022 = CHECK PAYMENT",
    "TransactionAmount": 2000.0,
    "TransactionDateTime": "2021-08-12 17:41:32",
    "CurrentBalanceAfterTran": 1191.67,
    "TransactionLifeCycleUniqueID": "1166971407",
    "AuthTranId": null,
    "RecoveredRewardPoints": null,
    "CheckNumber": null,
    "BalanceIndicator": "Active Balance",
    "DBIndicator": "Debit",
    "BankAccountLast4Digit": null,
    "CardnumLast4Digits": null,
    "InstallmentsBalance": 0.0,
    "InstallmentsPendingPurchases": 0.0,
    "StatementRemainingBalanceWithInstallmentDue": 0.0,
    "TransactionUniversalUniqueID": "1a6238d1-1b58-45cb-815d-6eeb56b827bb",
    "ReasonCode": null,
    "AdjustedCurrentBalance": null,
    "RevolvingCurrentBalance": null,
    "InfoPlan": null,
    "OriginalTranID": null,
    "TransactionReferenceID": null
  },
  "AccountNumber": "9000000500080257",
  "AdminNumber": "1194548",
  "RequestID": "1039346040",
  "Mode": "Transaction",
  "ClientId": null,
  "RequestUniversalUniqueID": "616f19a3-92c5-488c-9478-ce807dac30b7",
  "UpdateCallList": null,
  "RewardsRedemption": null,
  "Reward": null,
  "InfoReward": null,
  "InfoCollectionAlert": null,
  "InfoAlert": null,
  "InfoAgeOffAlert": null,
  "User": "cardholder",
  "DateandTime": "2021-08-12 17:41:32",
  "Source": "CoreIssue",
  "ServiceName": "System",
  "AccountUniversalUniqueID": null,
  "CardUniversalUniqueID": "d027f20f-aa51-4bc3-88d9-80f713bcba5",
  "AlertType": "RealTime",
  "ClientID": null,
  "TransactionSource": null,
  "InstitutionID": 5949,
  "ProductID": 5907,
  "AlertRecipientType": 1
}