Category links

API Links

Rejected Transactions

A transaction that is  rejected in ACH processing, limit checks, or due to an invalid card number (e.g., card does not exist in the system) is called a rejected transaction. Rejected transactions can be reviewed and updated with valid details. If rejected transactions need to be posted to targeted card accounts, then a transaction batch is created and submitted.

Post Rejected Transaction

Action: POST

Endpoint: /api/CoreCredit/RejectedTransactions/PostRejectedTransaction

POST /api/CoreCredit/RejectedTransactions/PostRejectedTransaction

Use this API to review and post rejected transactions to a batch. 

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

TransactionID

int64

Mandatory

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

CardNumber

string

Conditional

Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition: At least one of AccountNumber/CardNumber/AdminNumber is required.

Allowable Values:

19

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. Valid Values:0-9 Example:7314145404 Condition: At least one of AccountNumber/CardNumber/AdminNumber is required.

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 of AccountNumber/CardNumber/AdminNumber is required.

TransactionCode

string

Mandatory

TransactionCode A code to identify type of payment. Valid Values: A-Z 0-9 Format: xxxxxx Example:427248 = Principal Adjustment

Allowable Values:

20

TransactionAmount

decimal

Mandatory

Amount of Transaction Valid Values:0-9 Format: XXX.XX Example: 200.00

TransactionDescription

string

Optional

User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. Valid Values:A-Z,0-9 Format: xxxxxxxx Example:Purchase/Payment.

Allowable Values:

100

CardAcceptorNameAndLocation

string

Optional

Merchant name and location Valid Values:A-Z, 0-9 Example: Dental merchant, Nashua

Allowable Values:

50
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,
  "TransactionID": 178616446,
  "CardNumber": "0001010000000674594",
  "AccountNumber": "1000000700000720",
  "AdminNumber": 6247,
  "TransactionCode": "9025",
  "TransactionAmount": 110.0,
  "TransactionDescription": "Test",
  "CardAcceptorNameAndLocation": "test"
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Transaction Posted To Batch.",
    "Status": true,
    "ErrorCode": "ERR04049",
    "ResponseData": null
  }
}

Delete Rejected Transaction

Action: POST

Endpoint: /api/CoreCredit/RejectedTransactions/DeleteRejectedTransaction

POST /api/CoreCredit/RejectedTransactions/DeleteRejectedTransaction

Use this API is to delete the rejected transaction. The transaction can be rejected due to various reasons like a limit check, forced auth transactions that get rejected due to the invalid card number (not exists in the system), or transactions that get rejected via ACH.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

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

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

TransactionID

int64

Mandatory

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

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

BatchID

integer

Mandatory

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

TransactionID

int64

Mandatory

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "BatchID": 457873,
  "TransactionID": 178616461
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Rejected Transaction Deleted",
    "Status": true,
    "ErrorCode": "ERR01168",
    "ResponseData": null
  }
}

Delete Merchant Payment Batch

Action: POST

Endpoint: /api/CoreCredit/RejectedTransactions/DeleteMerchantPaymentBatch

POST /api/CoreCredit/RejectedTransactions/DeleteMerchantPaymentBatch

Use this API to delete the merchant payment batch when the merchant creates batches with payments on multiple accounts instead of posting separate payments.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

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

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

BatchStatus

integer

Mandatory

The current status of the batch

BatchID

integer

Mandatory

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

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

BatchStatus

integer

Mandatory

The current status of the batch. Valid values: 0- New 1- In Balance 2- Out of Balance 3- Needs Re-posting 4- Posted 5- Batch Flagged for Deletion 6- Summary 7- Batch Flagged for Error(s) 8- Rejected 9- Fraud 10- Processed 11- Non-Monetary Processed 12- Dispute Resolution Batch 16- Rejected: ACH Auto Return 17- Rejected: ACH Manual Return Example: 8 - Rejected

BatchID

integer

Mandatory

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

Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "BatchStatus": 8,
  "BatchID": 459651
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Batch deleted successfully",
    "Status": true,
    "ErrorCode": "ERR01006",
    "ResponseData": null
  }
}

Submit Merchant Payment Batch

Action: POST

Endpoint: /api/CoreCredit/RejectedTransactions/SubmitMerchantPaymentBatch

POST /api/CoreCredit/RejectedTransactions/SubmitMerchantPaymentBatch

Use this API to post batch transactions on target accounts.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

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

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:XXX Format:0-9 Example:1234

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

BatchID

integer

Mandatory

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

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": 459801
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Transaction posted successfully",
    "Status": true,
    "ErrorCode": "ERR01058",
    "ResponseData": null
  }
}

Create New Merchant Payment Batch

Action: POST

Endpoint: /api/CoreCredit/RejectedTransactions/CreateNewMerchantPaymentBatch

POST /api/CoreCredit/RejectedTransactions/CreateNewMerchantPaymentBatch

Use this API is to add transactions to the merchant payment batch. the merchant creates batches with payments of multiple accounts instead of posting payment on each account. To add more payment transactions to a batch, this API is used.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

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

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

MerchantID

integer

Mandatory

Description: Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXX Example: 562489

StoreID

integer

Optional

Specific code assigned to a Store. Valid Values: XXX Format: 0-9 Example: 1234

RegisterID

integer

Optional

Unique ID assigned to a Register. Valid Values: a-z 0-9 Format: xxxxx Example: 123456

NumberItems

integer

Mandatory

Number of items in the batch as input by user. Valid Values: 0-9 Example: 10

BatchTotalDebits

decimal

Mandatory

Description: The total amount of credits in the batch as input by the user. Valid Values: 0-9 Example: 500.00

BatchTotalCredits

decimal

Mandatory

Description: The total amount of debits in the batch as input by the user. Valid Values: 0-9 Example: 500.00

BatchDescription

string

Optional

A short description of the Batch. Valid Values: A-Z, 0-9 Example: Merchant 1 payment batch.

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

MerchantID

integer

Mandatory

Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXX Example: 562489

StoreID

integer

Optional

Specific code assigned to a Store. Valid Values: XXX Format: 0-9 Example: 1234

RegisterID

integer

Optional

Unique ID assigned to a Register. Valid Values: a-z 0-9 Format: xxxxx Example: 123456

NumberItems

integer

Mandatory

Number of items in the batch as input by user. Valid Values: 0-9 Example: 10

BatchTotalCredits

decimal

Mandatory

The total amount of credits in the batch as input by the user. Valid Values: 0-9 Example: 500.00

BatchDescription

string

Optional

A short description of the Batch. Valid Values: A-Z, 0-9 Example: Merchant 1 payment batch.

Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "MerchantID": 5030,
  "StoreID": null,
  "RegisterID": 11332,
  "NumberItems": 1,
  "BatchTotalCredits": 8399.0,
  "BatchDescription": "Transaction Rejected.  Account Card Limit Reject."
}
Response fields detail
Fields Description

BatchID

integer

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

BatchID

integer

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

Sample response body 

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "BatchID": 459711
    }
  }
}

Get Rejected Transactions

Action: POST

Endpoint: /api/CoreCredit/RejectedTransactions/GetRejectedTransactions

POST /api/CoreCredit/RejectedTransactions/GetRejectedTransactions

Use this API to obtain a list of all rejected transactions. It uses a combination of multiple parameters, such as date range, merchant ID, product ID, account number, and transaction amount.

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

DateFrom

datetime

Optional

Start date of rejected transaction search. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020

DateTo

datetime

Optional

End date of rejected transaction search. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020

MerchantID

integer

Optional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345

Allowable Values:

20

ProductID

integer

Optional

Product ID Valid Values:0-9 Format:XXXX Example:1234

Allowable Values:

20

TransactionsSourceType

string

Optional

Description: Transactions source like ACH, manual etc. Valid Values: Refer Appendix Section 5.42 (Transaction Source Type). Example:5=IPM, 14= ACH

Allowable Values:

20

BatchStatus

string

Optional

The current status of the batch. Valid values: 5 = Batch Flagged for Deletion 7 = Batch Flagged for Error(s) 12 = Dispute Resolution Batch 9 = Fraud 1 = In-Balance 3 = Needs Re-posting 11 = Non-Monetary Processed 2 = Out-of-Balance 4 = Posted 10 = Processed 8 = Rejected 16 = Rejected: ACH Auto Return 17 = Rejected: ACH Manual Return 6 = Summary

Allowable Values:

20

AccountNumber

string

Optional

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

BatchID

string

Optional

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

Allowable Values:

19

TransactionAmount

decimal

Optional

Amount of Transaction Valid Values:0-9 Format: XXX.XX Example: 200.00

CardAcceptorNameLocation

string

Optional

Name and location details of merchant Valid Values: a-z A-Z Format: XXXXXXXXXXXXXXXX Example: Dental merchant, Nashua

Allowable Values:

20
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,
  "DateFrom": null,
  "DateTo": null,
  "MerchantID": null,
  "ProductID": null,
  "TransactionsSourceType": null,
  "BatchStatus": null,
  "AccountNumber": null,
  "BatchID": null,
  "TransactionAmount": null,
  "CardAcceptorNameLocation": null
}
Response fields detail
Fields Description

RejectedTransactionList

array

Array of Rejected Transactions list.

Sample response body 

{
  "application/json": {
    "Message": "Rejected transaction retrieved successfully",
    "Status": true,
    "ErrorCode": "ERR01046",
    "ResponseData": {
      "RejectedTransactionList": [
        {
          "AdminNumber": 0,
          "BatchID": "457873",
          "EffectiveDateTime": "01/13/2017 23:20:14",
          "ProductName": "1313 = abcd",
          "ClientName": "5030",
          "AccountNumber": "1000000700000720",
          "MaskedCardNumber": "0001010000000674594",
          "CardHolderName": "FirstName_7607 MiddleName LASTNAME",
          "TransactionCode": "9166",
          "TransactionAmount": "0.0000",
          "PostingReference": "Invalid Amount",
          "UserID": "portalsuperuser",
          "BatchStatus": "8",
          "TransactionID": "178616461",
          "TransactionDescription": "241 =  MERCHANDISE RETURN"
        }
      ]
    }
  }
}

Review Rejected Transaction

Action: POST

Endpoint: /api/CoreCredit/RejectedTransactions/ReviewRejectedTransaction

POST /api/CoreCredit/RejectedTransactions/ReviewRejectedTransaction

Use this API to review the details of a rejected transaction by providing the transaction ID and other details, like transaction originating source, merchant name, posting date, and posting reference.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

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

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

TransactionID

int64

Mandatory

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

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

TransactionID

int64

Mandatory

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

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,
  "TransactionID": 178616461
}
Response fields detail
Fields Description

TransactionID

string

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

MerchantName

string

Name of the Merchant Valid Values:A-Z, 0-9 Format:XXXXXX Example:Greensky LLC

Allowable Values:

20

AccountNumber

string

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

MaskedCardNumber

string

Masked Card Number.For security purposes, the card number always displays partially masked with only the first six and last four numbers in the clear. Valid Values:0-9 Example:123456XXXXXX1234

Allowable Values:

19

FirstName

string

Card holder's First name. Valid Values:A-Z Format:XXXXX Example:User1

Allowable Values:

40

LastName

string

Card holder's last name. Valid Values:A-Z Format:XXXXX Example:Smith

Allowable Values:

40

TransactionsSourceType

string

Ttransaction source like ACH, manual etc Valid Values:Please refer Example:5=IPM, For  Retail =29(Installment Purchase) Retail =39(Credit Purchase) Retail=23 (Manual Auth)

Allowable Values:

4

AuthorizationCode

string

The authorization approval code for the transaction. Valid Values:0-9 Example:12354

Allowable Values:

50

TransactionDescription

string

Get or set TransactionDescription

Allowable Values:

100

TerminalID

string

The terminal identifier for the transaction. Valid Values: A to Z, 0 to 9

Allowable Values:

50

TransactionCode

string

Payment Transaction Code Valid Values:0-9 Format:XXXXX Example: 86221 = AUTO ACH PAYMENT

Allowable Values:

8

PostingDateTime

datetime

PostingDateTime

ReturnReasonCode

string

Return Reason Code For ACH payment Reversal Transactions Valid Values:XXXXX Format:12345

Allowable Values:

5

PostingReference

string

Posting reference (Like -Transaction Posted Successfully) Valid Values: A-Z 0-9 Format: XXXXXXXXXXXXX Example: Transaction Posted Successfully

Allowable Values:

128

CardAcceptorNameLocation

string

Name location value of entity accepting card for transaction Valid Values: 0-9 a-z Format: xxx xxx Example: Merchant 1, WA

Allowable Values:

50

TransactionID

string

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

MerchantName

string

Name of the Merchant Valid Values:A-Z, 0-9 Format:XXXXXX Example:abcd

Allowable Values:

20

AccountNumber

string

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

MaskedCardNumber

string

Masked Card Number.For security purposes, the card number always displays partially masked with only the first six and last four numbers in the clear. Valid Values:0-9 Example:123456XXXXXX1234

Allowable Values:

19

FirstName

string

Card holder's First name. Valid Values:A-Z Format:XXXXX Example:User1

Allowable Values:

40

LastName

string

Card holder's last name. Valid Values:A-Z Format:XXXXX Example:Smith

Allowable Values:

40

TransactionsSourceType

string

Description: Transactions source like ACH, manual etc. Valid Values: Refer Appendix Section 5.42 (Transaction Source Type). Example:5=IPM, 14= ACH

Allowable Values:

4

AuthorizationCode

string

The authorization approval code for the transaction. Valid Values:0-9 Example:12354

Allowable Values:

50

TransactionDescription

string

Description: User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. Valid Values:A-Z,0-9 Format: xxxxxxxx Example:Purchase/Payment.

Allowable Values:

100

TerminalID

string

The terminal identifier for the transaction. Valid Values: A to Z, 0 to 9

Allowable Values:

50

TransactionCode

string

Description- A code to identify type of payment. Valid Values: The valid values of Transaction Code can be fetched from GetTranCodeByUserID API. Format: xxxxxx Example:427248 = Principal Adjustment

Allowable Values:

8

PostingDateTime

datetime

Description: The date and time the transaction posted to the account. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/02/2020 10:00:00

ReturnReasonCode

string

Return Reason Code For ACH payment Reversal Transactions Valid Values:XXXXX Format:12345

Allowable Values:

5

PostingReference

string

Posting reference (Like -Transaction Posted Successfully) Valid Values: A-Z 0-9 Format: XXXXXXXXXXXXX Example: Transaction Posted Successfully

Allowable Values:

128

CardAcceptorNameLocation

string

Name location value of entity accepting card for transaction Valid Values: 0-9 a-z Format: xxx xxx Example: Merchant 1, WA

Allowable Values:

50

Sample response body 

{
  "application/json": {
    "Message": "This rejected transaction needs a review for further re-posting",
    "Status": true,
    "ErrorCode": "ERR04119",
    "ResponseData": {
      "TransactionID": "178616461",
      "MerchantName": "5030",
      "AccountNumber": "1000000700000720",
      "MaskedCardNumber": "0001010000000674594",
      "FirstName": "FirstName_7607",
      "LastName": "LASTNAME",
      "TransactionsSourceType": "22",
      "AuthorizationCode": null,
      "TransactionDescription": "abcd",
      "TerminalID": null,
      "TransactionCode": "9166",
      "PostingDateTime": "01/13/2017 23:20:14",
      "ReturnReasonCode": null,
      "PostingReference": "Invalid Amount",
      "CardAcceptorNameLocation": null
    }
  }
}