Core Card Api Quick Start

Cancel Balance Transfer

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/CancelBalanceTransfer

Use this API to cancel the pending balance transfer request. If a user wants to cancel the in-process balance transfer (balance transfer processed through balance transfer API) into another account (Loan/Credit) associated with a different institution then the user needs to provide an originator payment ID in the API input. API returns the response in terms of success or failure.

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
OriginatorPaymentID string Mandatory	This is the ID created at the issuer end. This ID will be acting as lifecycle ID. Valid Values: A-Z, 0-9 Example:1236547896325874 Allowable Values: 100

Fields

Description

Source

string

Mandatory

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

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

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:

CurrencySymbolType

string

Optional

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

Allowable Values:

Language

string

Optional

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

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

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:

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:

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:

RequestTime

datetime

Optional

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

OriginatorPaymentID

string

Mandatory

This is the ID created at the issuer end. This ID will be acting as lifecycle ID. Valid Values: A-Z, 0-9 Example:1236547896325874

Allowable Values:

100

Sample request body

{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "OriginatorPaymentID": "1857444544"
}

Response fields details

Fields	Description
OriginatorPaymentID string	This is the ID created at the issuer end. This ID will be acting as lifecycle ID. Valid Values: A-Z, 0-9 Example:123654789 Allowable Values: 100
eComPaymentId string	Unique ID received from 3rd party Payment Gateway API (ACI API). Valid Values: A-Z, 0-9 Example:123654789 Allowable Values: 100
AciStatusCode string	Status Code received from 3rd party Payment gateway (ACI). Valid Values:Check, Electronic, Rejected, Error, Unknown Example:Check Allowable Values: 100
AciStatusMessage string	Status message received from 3rd party Payment gateway (ACI). Valid Values: A-Z, 0-9 Example:Your request has been processed successfully. Allowable Values: 100
httpCode string	Specific code received in response of the API Request. Valid Values:0-9 Example:404 Allowable Values: 100
ExpectedCancelDate datetime	Expected Cancellation Date of Transaction. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example:02/20/2020 11:00:00
PaymentAmount decimal	Total amount for the Balance Transfer. Format: XX.XX Valid Values:0-9 Example:510.00

Fields

Description

OriginatorPaymentID

string

This is the ID created at the issuer end. This ID will be acting as lifecycle ID. Valid Values: A-Z, 0-9 Example:123654789

Allowable Values:

100

eComPaymentId

string

Unique ID received from 3rd party Payment Gateway API (ACI API). Valid Values: A-Z, 0-9 Example:123654789

Allowable Values:

100

AciStatusCode

string

Status Code received from 3rd party Payment gateway (ACI). Valid Values:Check, Electronic, Rejected, Error, Unknown Example:Check

Allowable Values:

100

AciStatusMessage

string

Status message received from 3rd party Payment gateway (ACI). Valid Values: A-Z, 0-9 Example:Your request has been processed successfully.

Allowable Values:

100

httpCode

string

Specific code received in response of the API Request. Valid Values:0-9 Example:404

Allowable Values:

100

ExpectedCancelDate

datetime

Expected Cancellation Date of Transaction. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example:02/20/2020 11:00:00

PaymentAmount

decimal

Total amount for the Balance Transfer. Format: XX.XX Valid Values:0-9 Example:510.00

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "OriginatorPaymentID": "4120982",
    "eComPaymentId": "99081280",
    "AciStatusCode": "0",
    "AciStatusMessage": "Your request has been processed successfully.",
    "httpCode": "200",
    "ExpectedCancelDate": null,
    "PaymentAmount": null
  }
}