Category links

API Links

Release OTB

Open to Buy decreases when any purchase transaction is received on a card account. A cardholder may dispute the transaction received on the account due to various reasons. When a dispute is successfully lodged and OTB is blocked, you can use an API to release open to buy equivalent to the dispute transaction amount.

Clear Outstanding

Action: POST

Endpoint: /api/CoreCredit/Authorizations/ClearOutstanding

POST /api/CoreCredit/Authorizations/ClearOutstanding

CoreCARD stores pre-authorization transaction details in the system until they are settled. A user can utilize the ClearOutstanding API to release the amount that is placed on hold due to the pending pre-authorization transactions. By providing a mandatory transaction ID, along with an account identifier like account number, card number, or admin number, a user can release an outstanding authorization hold amount to be available in OTB balance.

Request fields detail
Fields Description

Source

string

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

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

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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:Atleast CardNumber / Account Number / AdminNumber should be entered.

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: Atleast CardNumber / Account Number / AdminNumber should be entered.

Allowable Values:

19

CardNumber

string

Conditional

Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

16

TransactionID

int64

Mandatory

Transaction Number for transaction being posted. Valid Values:0-9 Format:XXXXXXXXX Example:236547895

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

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,
  "AdminNumber": null,
  "AccountNumber": "8110000000000034",
  "CardNumber": null,
  "TransactionID": 123372036854907813,
  "InstitutionID": 3241
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Clear Outstanding Auth Processed Successfully.",
    "Status": true,
    "ErrorCode": "ERR01030",
    "ResponseData": {}
  }
}