PaymentReceived
Action: POST
Endpoint: /api/WebHookNotification/AlertNotification/PaymentReceived
Request fields details
Fields | Description |
---|---|
UpdateCallList
|
That when Update call List array will be Open and Provide a note That in which case these Tag will have value. |
MonetaryLog
|
Group of fields passed in webhook |
TransactionAmount decimal |
Total amount for which credit was made |
PrimaryCurrencyCode string |
Primary Currency will have value as 'USD' Allowable Values: 20 |
InfoReward
|
Group of fields passed in webhook |
InfoAlert array |
Group of fields passed in webhook |
Tab string |
Indicates tab in system under which this webhook is available Valid Values:Status, Period, Monetary, Security and Cards Allowable Values: 40 |
Category string |
Indicates category of alert triggered Allowable Values: 40 |
SubCategory string |
Indicates subcategory of Category of alert triggered Allowable Values: 40 |
CardnumLast4Digits string |
Last 4 digits of card number Allowable Values: 4 |
FirstName string |
First name of Account holder Allowable Values: 50 |
LastName string |
Last Name of Account holder Allowable Values: 50 |
StatementMonth string |
Denote month for which statement is generated Valid values: 1 to 12 Allowable Values: 50 |
AvailableOTB decimal |
Amount available for further purchases on card |
StatementID string |
Unique identifier for Statement Allowable Values: 9 |
StatementDate datetime |
Date when statement was generatedFormat: YYYYMMDDHHMMSS |
PrimaryEmail string |
Email ID of Primary cardholder. This field is available only when AlertRecipientType is 1 or 3 or 5 Allowable Values: 50 |
AuthUserEmailID string |
Email ID of Secondary cardholder. This field is available only when AlertRecipientType is 4 or 5 Allowable Values: 50 |
CosignerEmailID string |
Email ID of Cosigner on account. This field is available only when AlertRecipientType is 2 or 3 Allowable Values: 50 |
PaymentScheduleType string |
Indicates type of payment for payment schedule which triggered payment Valid values: Statement Balance or Minimum Due or Fixed Amount or Current Balance Allowable Values: 20 |
PaymentScheduleDate datetime |
Date when payment schedule was Added(FORMAT: YYYYMMDD) |
BankName string |
Name of bank whose account was used to create payment schedule Allowable Values: 70 |
ScheduleID string |
Unique identifier for added payment schedule Allowable Values: 10 |
PaymentScheduleFrequency string |
Indicates Frequency of payment schedule as One Time or Recurring Allowable Values: 30 |
BankMethodName string |
Unique Identifier for the bank account in CoreCard system Allowable Values: 25 |
NextSchedulePaymentdate datetime |
Date when next payment is scheduled to be triggered(Format: MM/DD/YYYY hhmmss) |
BankAccountLast4Digit string |
Last 4 digits of bank account number in ACH payments from Allowable Values: 4 |
PaymentProcessDate string |
This is the date when the BillpaymentSource(IPAY) initiated the payment to the subscriber system. Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
RewardsRedemption array |
Group of fields passed in webhook |
Reward array |
Group of fields passed in webhook |
RewardInfo array |
Group of fields passed in webhook |
InfoCollectionAlert array |
Group of fields passed in webhook |
InfoAgeOffAlert array |
Group of fields passed in webhook |
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 Format:XXXXXXXXXX Example:12345 Allowable Values: 64 |
CardUniversalUniqueID string |
Universal Unique ID for Admin Format:XXXXXXXXXX Example:12345 Allowable Values: 64 |
ClientID string |
Corecards Client ID Allowable Values: 64 |
RequestUniversalUniqueID string |
UniversalUniqueID Request Allowable Values: 64 |
User string |
User Allowable Values: 40 |
DateandTime DateTime |
Timestamp when notification was sent Format:MM-DD-YYYY hh:mm:ss:sss |
Source string |
Source Allowable Values: 20 |
ServiceName string |
ServiceName Allowable Values: 40 |
AlertType string |
Indicates type of Alert Valid Values:RealTime 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
{ "InfoAlert": { "Tab": "Monetary", "Category": "Payment Received", "SubCategory": null, "CardnumLast4Digits": "1891", "FirstName": "Eduardo", "LastName": "Leal", "StatementMonth": null, "AvailableOTB": 1513.07, "StatementID": null, "StatementDate": null, "PrimaryEmail": "edusmleal@gmail.com", "AuthUserEmailID": null, "CosignerEmailID": null, "PaymentScheduleType": null, "PaymentScheduleDate": null, "BankName": "Debit Card Token", "ScheduleID": "123456", "PaymentScheduleFrequency": null, "BankMethodName": "2285458", "NextSchedulePaymentdate": null, "BankAccountLast4Digit": "c526", "TransactionAmount": 802.94, "PrimaryCurrencyCode": "USD", "TransactionCurrencyCode": "USD", "PaymentTransactionID": "1144331635", "Source": null, "PaymentProcessDate": "01/14/2017 12:00:00:00", "CurrentBalance": 2486.3, "TransactionUniversalUniqueID": "6e65dc1c-68ee-4660-9449-288fe3b20dec", "XAmount": 802.94, "HoldOTBReleaseDate": "01/17/2017 12:00:00:00" }, "AccountNumber": "9110000000001234", "AdminNumber": "1341234", "RequestID": "38879508", "Mode": "ALERT", "AccountUniversalUniqueID": "9894f28b-d051-4eaa-9e48-a3a7d5b4a6f7", "CardUniversalUniqueID": "90cedd59-c2e8-47e2-b15e-0fdb256ea7b2", "ClientID": null, "RequestUniversalUniqueID": "df370660-cdea-400a-b2b6-2cdabd675a98", "User": "System", "DateandTime": "2021-08-16 09:25:30", "Source": "System", "ServiceName": null, "AlertType": "RealTime", "TransactionSource": null, "InstitutionID": 5949, "ProductID": 5907, "AlertRecipientType": 1, "UpdateCallList": null, "MonetaryLog": null }