Category links

API Links

Credit Balance Refund

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/CreditBalanceRefund

Use this API to initiate a credit balance refund that could have occurred due to card payer overpayment or another condition. Additionally, this API enables a user to select the mode, such as ACH or other, by which a credit balance refund is performed.

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one Account identifier input parameter should be passed

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one Account identifier input parameter should be passed

CreditBalance

decimal

Mandatory

The amount which has to be refunded Valid Values:0-9 Format:XX.XX Example:22.00

RefundMode

integer

Mandatory

Mode how the balance has been refund.like ACH, manual,other Valid Values:0,1 Format:XXXXXXXXXXXXXXXX Example:0 = ACH OR 1 = Other,2 – Adjust to Loan Account

MethodName

int64

Conditional

Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account. This is required If User wants to send transaction in ACH. Valid Values:0-9 Format:XXXX Example:4092 Condition: If Payment mode is ACH then only Methodname is required.

LoanAccountNumber

string

Conditional

Account Number on which the refund amount should be adjusted. Valid Values:0-9 Format:XXXXXXXXXXXXXXX Example:2342432543512 Condition:It should be mandatory if Refund mode is 2 i.e Adjust to Loan Account.

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "5000000000011550",
  "AdminNumber": 62065,
  "CreditBalance": 364.6,
  "RefundMode": 0,
  "LoanAccountNumber": "5000000000014343",
  "MethodName": 2881
}
Response fields details
Fields Description

ErrorNumber

string

Error Code which has been defined for the API response. Valid Values:0-9, A-Z Format:XXXXX Example:ERR01013

ErrorMessage

string

Error Message which has been defined for the Error Codes,like ERR01013 -Credit balance refund retrieved successfully . Valid Values:0-9, A-Z Format:XXXXX Example:Credit balance refund retrieved successfully

ErrorFound

string

Error is been there in the API response. Valid Values:Y/N Format:XXXXX Example:Yes/No

Sample response body

{
  "Message": "Credit balance refund retrieved successfully.",
  "Status": true,
  "ErrorCode": "ERR01013",
  "ResponseData": null
}