Category links

API Links

PaymentReturn

Action: POST

Endpoint: /api/WebHookNotification/UpdateNotification/PaymentReturn

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

Request fields details
Fields Description

AccountNumber

string

Optional

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

Allowable Values:

19

AdminNumber

string

Mandatory

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

RequestID

string

Optional

Primary Key for API Format:XXXXXXXXXXXXXXXX Example:12345

Allowable Values:

19

Mode

string

Optional

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

Allowable Values:

10

AccountUniversalUniqueID

string

Optional

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

Allowable Values:

64

CardUniversalUniqueID

string

Optional

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

Allowable Values:

64

ClientID

string

Optional

Corecard’s Client ID

Allowable Values:

64

RequestUniversalUniqueID

string

Optional

UniversalUniqueID Request

Allowable Values:

64

UpdateCallList

array

Optional

Group of fields passed in webhook

MonetaryLog

Optional

Group element will always null for collection

InfoAlert

Optional

RewardsRedemption

Optional

Group element will always null for collection

Reward

Optional

Group element will always null for collection

InfoReward

Optional

InfoCollectionAlert

Optional

InfoAgeOffAlert

Optional

User

string

Optional

API User ID who performed the activity which triggered the event

Allowable Values:

40

DateandTime

DateTime

Optional

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

Source

string

Optional

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

Optional

Name of API service (webhook) triggered

Allowable Values:

40

AlertType

string

Optional

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

Allowable Values:

15

TransactionSource

string

Optional

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

Allowable Values:

40

InstitutionID

integer

Optional

A unique identifier assigned by CoreCard for Institution

ProductID

integer

Optional

A unique identifier assigned by CoreCard for Product

AlertRecipientType

integer

Optional

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": "1100001000009006",
  "AdminNumber": "5110",
  "RequestID": "83090",
  "Mode": "Transaction",
  "AccountUniversalUniqueID": "2196a561-1245-4c82-924c-3465230d6af7",
  "CardUniversalUniqueID": "df68d5a9-8aa7-4fe9-8705-c135f6409612",
  "ClientID": null,
  "RequestUniversalUniqueID": "11d04c39-39da-4f09-b252-3d5a13b11829",
  "UpdateCallList": null,
  "User": "cardholder",
  "DateandTime": "2021-08-12 17:41:32",
  "Source": "CoreIssue",
  "ServiceName": "System",
  "AlertType": "RealTime",
  "TransactionSource": null,
  "InstitutionID": 5949,
  "ProductID": 5907,
  "AlertRecipientType": 1,
  "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
  }
}