Category links

API Links

PaymentScheduleInsert

Action: POST

Endpoint: /api/WebHookNotification/UpdateNotification/PaymentScheduleInsert

This webhook is triggered when a new payment schedule is added for an account. 1.0 1.0 2.0 Neerja Agrawal Initial Release 10/12/2021

Request fields details
Fields Description

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

Indicates the type of activity performed which triggered this webhook Possible Value: Alert, Insert, Transaction

Allowable Values:

10

AccountUniversalUniqueID

string

Universal Unique ID for Account Format:XXXXXXXXXX Example:7408f969-6e0c-4a3f-8fba-3316f6f77db6

Allowable Values:

64

CardUniversalUniqueID

string

Universal Unique ID for Card Format:XXXXXXXXXX Example:fbe61b75-6751-4add-9c44-7832ccf399e9

Allowable Values:

64

ClientID

string

Corecard’s Client ID

Allowable Values:

64

RequestUniversalUniqueID

string

UniversalUniqueID Request

Allowable Values:

64

UpdateCallList

array

Group of fields passed in webhook

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

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

InfoAlert

RewardsRedemption

Group element will always null for collection

Reward

Group element will always null for collection

InfoReward

InfoCollectionAlert

InfoAgeOffAlert

User

string

API User ID who performed the activity which triggered the event

Allowable Values:

40

DateandTime

DateTime

Timestamp when notification was sent YYYY-MM-DD hh:mm:ss:sss (24-hour Format)

Source

string

Indicates if ACH payment was made from CoreCredit panel or some other source (API) Valid Values: CoreCredit, API, Self Service, CoreCollect, IVR

Allowable Values:

20

ServiceName

string

Name of API service (webhook) triggered

Allowable Values:

40

AlertType

string

Indicates type of Alert Possible values: Real-Time or Re Try(due to time-out)

Allowable Values:

15

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

Sample request body
{
  "AccountNumber": "9000000500294419",
  "AdminNumber": "689281",
  "RequestID": "1043049432",
  "Mode": "Insert",
  "AccountUniversalUniqueID": "9e614718-cde7-4ca5-b762-bf35b6325a59",
  "CardUniversalUniqueID": "6b664ad8-7f6c-4c5f-98be-36be19229da9",
  "ClientID": null,
  "RequestUniversalUniqueID": "db89a6c5-f5a4-429e-be11-b59baa82ada1",
  "UpdateCallList": {
    "Category": {
      "CategoryName": "Payment Schedule",
      "CategoryID": 1690930,
      "CategoryFieldList": [
        {
          "ModifiedFieldName": "Fixed Amount",
          "OldValue": null,
          "NewValue": "115.44"
        }
      ],
      "ChangeStatusFor": null,
      "CurrentManualStatus": null,
      "CurrentGeneratedStatus": null,
      "DerivedPartnerStatus": null,
      "ManualStatusListOld": null,
      "ManualStatusListNew": null,
      "CardnumLast4Digits": "1972"
    }
  },
  "User": "adminuser",
  "DateandTime": "2021-08-16 00:11:01",
  "Source": "External API",
  "ServiceName": "svcPaymentSchedule",
  "AlertType": "RealTime",
  "TransactionSource": null,
  "InstitutionID": 5949,
  "ProductID": 5907,
  "AlertRecipientType": 1
}