Category links

API Links

Merchant Balance To Batch

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/MerchantBalanceToBatch

Use this API to balance the merchant payment batch. The batch is in balance when the number of debits or credits entered by the user and the number of debits or credits calculated by the system is the same.

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

BatchID

integer

Mandatory

The identifier of the batch, which is assigned by the system. Valid Values: 0-9 Example: 1234

NumberDifference

decimal

Mandatory

The difference between the number of items the user entered and the number of items calculated by the system. Valid Values: 0-9 Example: 2

DebitDifference

decimal

Mandatory

The difference between the amount of debits the user entered and the amount of debits calculated by the system. Valid Values: 0-9 Format: XXX.XX Example: 200.00

CreditDifference

decimal

Mandatory

The difference between the amount of credits the user entered and the amount of credits calculated by the system. Valid Values: 0-9 Format: XXX.XX Example: 200.00

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,
  "BatchID": 459901,
  "NumberDifference": 2.0,
  "DebitDifference": 0.0,
  "CreditDifference": 5.0
}
Response fields details
Fields Description

Sample response body

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": null
}