Category links

API Links

CreditBalanceRefundSent

Action: POST

Endpoint: /api/WebHookNotification/UpdateNotification/CreditBalanceRefundSent

This webhook is triggered when a credit balance refund transaction is posted on account. 1.0 1.0 2.0 Rekha Shelar Initial Release 16/12/2022

Request fields details
Fields Description

AccountNumber

string

Account Number associated with the event

Allowable Values:

19

AdminNumber

string

Admin Number associated with the event

RequestID

string

Primary Key for API

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

Allowable Values:

64

CardUniversalUniqueID

string

UniversalUniqueID of Card

Allowable Values:

64

ClientID

string

Corecard’s Client ID

Allowable Values:

64

RequestUniversalUniqueID

string

UniversalUniqueID Request

Allowable Values:

64

UpdateCallList

Group of fields passed in webhook

MonetaryLog

Group of fields passed in webhook

Category

string

Group of fields passed in webhook

SubCategory

string

Category

TranId

string

Unique identifier for Transaction ID of Credit made

Allowable Values:

10

TransactionAmount

decimal

Total amount for which credit was made

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

BalanceIndicator

string

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

Allowable Values:

20

BankAccountLast4Digit

string

Bank AccountNumber last 4 digits of account from where funds are credited. Condition: This field will only be available when refund mode is ACH.

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

CardnumLast4Digits

string

Last 4 digits of card number.

Allowable Values:

4

TransactionReferenceID

int64

FirstName

string

First name of Account holder

Allowable Values:

50

LastName

string

Last Name of Account holder

Allowable Values:

50

PrimaryEmail

string

Email ID of Primary cardholder. This field is available only when AlertRecipientType is 1 or 3 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

AuthUserEmailID

string

Email ID of Secondary cardholder. This field is available only when AlertRecipientType is 4 or 5

Allowable Values:

50

BankName

string

Indicates the Name of the Bank to whose account the credit balance is refunded via ACH. Condition: This field will only be available when refund mode is ACH.

Allowable Values:

70

BankMethodName

string

Unique Identifier for the bank account in CoreCard system. Condition: This field will only be available when refund mode is ACH.

Allowable Values:

25

RefundType

string

Indicates if Credit Balance refund initiation was Automatic or Manual

RefundMode

string

Indicates the Refund Mode; ACH, Other, Adjust to Loan Account Condition: Other Refund Mode is when:For Manual Refund Other option is selected. As per Product set up when Automatic transaction posted for credit balance refund.

PrimaryCurrencyCode

string

Primary Currency will have value as 'USD'

Allowable Values:

20

AvailableOTB

decimal

Amount available for further purchases on card

LoanAccountNumber

string

Loan account number on which credit balance refund Adjusted Condition: Loan Account number only available when Refund Mode is Adjust to Loan Account.

InfoAlert

RewardsRedemption

Reward

RewardInfo

InfoCollectionAlert

InfoAgeOffAlert

User

string

User Indicates User ID of User who performs the Credit balance Refund. Valid Values: CoreCredit user, API user, System

Allowable Values:

40

DateandTime

DateTime

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

Source

string

Source Indicates if the Credit Balance is Refunded from CoreCredit panel or some other source (API) or Automatic via System.Valid Values: CoreCredit, API, System

Allowable Values:

20

ServiceName

string

Name of API service (webhook) triggered

Allowable Values:

40

AlertType

string

Indicates type of Alert Possible 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

TransactionCode

integer

Actual transaction code used to map this transaction

Sample request body
{
  "AccountNumber": "9000000630283498",
  "AdminNumber": "1358966",
  "RequestID": "1427843180",
  "Mode": "Transaction",
  "AccountUniversalUniqueID": "6679ac61-7f1a-494e-9e57-a3b8545d0e0a",
  "CardUniversalUniqueID": "0c439c82-f920-4d29-b122-a164cd255795",
  "ClientID": null,
  "RequestUniversalUniqueID": "a8b427e8-a04d-497d-b7f8-1b8a4276a59c",
  "UpdateCallList": null,
  "MonetaryLog": {
    "Category": "Monetary",
    "SubCategory": "Credit Balance Refund Sent",
    "TranId": "2032111234",
    "TransactionType": 50,
    "TransactionCode": 37123,
    "TransactionDescription": "37123 = MANUAL CREDIT BALANCE REFUND",
    "TransactionAmount": 170.0,
    "TransactionDateTime": "2022-09-26 20:00:01",
    "CurrentBalanceAfterTran": 0.0,
    "TransactionLifeCycleUniqueID": null,
    "AuthTranId": null,
    "RecoveredRewardPoints": null,
    "CheckNumber": null,
    "BalanceIndicator": "Active Balance",
    "DBIndicator": "Debit",
    "BankAccountLast4Digit": "2222",
    "TransactionUniversalUniqueID": "068d02cb-c888-4a4b-b2ea-00cd99f18cb1",
    "ReasonCode": null,
    "InstallmentsBalance": null,
    "InstallmentsPendingPurchases": null,
    "StatementRemainingBalanceWithInstallmentDue": null,
    "AdjustedCurrentBalance": null,
    "RevolvingCurrentBalance": null,
    "InfoPlan": null,
    "OriginalTranID": null,
    "CardnumLast4Digits": "1234",
    "TransactionReferenceID": null,
    "FirstName": "Louis",
    "LastName": "Recupero",
    "PrimaryEmail": "abc@xyz.com",
    "CosignerEmailID": null,
    "AuthUserEmailID": null,
    "BankName": "ABC Bank",
    "BankMethodName": "2121111",
    "RefundType": "Manual",
    "RefundMode": "ACH",
    "PrimaryCurrencyCode": "lclUnitedStates",
    "AvailableOTB": 1200000.0,
    "LoanAccountNumber": null,
    "SettlementDate": "2022-09-26"
  },
  "InfoAlert": null,
  "RewardsRedemption": null,
  "Reward": null,
  "RewardInfo": null,
  "InfoCollectionAlert": null,
  "InfoAgeOffAlert": null,
  "User": "User1",
  "DateandTime": "2022-09-26 20:00:01",
  "Source": "CoreCredit",
  "ServiceName": null,
  "AlertType": "RealTime",
  "TransactionSource": "ACH",
  "InstitutionID": 12345,
  "ProductID": 1122,
  "AlertRecipientType": 1,
  "TransactionCode": null
}