Category links

API Links

Update Travel Notification

Action: POST

Endpoint: /api/CoreCredit/CardManagement/TravelSettingCRUD

A cardholder can use the API's travel notifications functionality which allows the customer to perform international transactions for a given admin number and a specific country within the defined date range. A cardholder can add a new travel notification request or edit or delete an existing request.

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

AdminNumber

int64

Optional

Admin number Valid Values: 0-9 Example: 12345

RequestType

integer

Optional

Request Type defines the action to be performed. Valid Values: 0, 1, 2 Format: X Example: 0-Add, 1-Delete, 2-Update

TNUniqueID

int64

Conditional

Travel Notification's Unique ID Valid Values: 0-9 Example: 12345 Condition: It is required when the value of RequestType is 1 or 2.

CountryOfTravel

string

Conditional

Country of Travel Please refer to Appendix file section 5.1 for a list of valid codes and values. Valid Values:A-Z Format:XX Example:IN, US, GE Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details

Allowable Values:

3

TravelStartDate

datetime

Conditional

Travel Start Date Format: MM/dd/yyyy Example: 02/25/2020 Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details

TravelEndDate

datetime

Conditional

Travel End Date Format: MM/dd/yyyy Example: 02/25/2020 Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details

StatusOfTravel

integer

Conditional

Status of Travel 1 = Active, 2 = Expired, 3 = Deleted Valid Values: 1, 2, 3 Format: X Example:1,2,3 Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details

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": 129333,
  "RequestType": 0,
  "TNUniqueID": null,
  "CountryOfTravel": "USA",
  "TravelStartDate": "04/04/2020 00:00:00",
  "TravelEndDate": "04/10/2020 00:00:00",
  "StatusOfTravel": 1
}
Response fields details
Fields Description

ResponseID

string

This number will ensure that API hit our internal servers. This will always be unique. API is returned from our external server. Valid Values: 0-9 Format: xxx Example: 200

Allowable Values:

15

Sample response body

{
  "Message": "Travel notification added successfully",
  "Status": true,
  "ErrorCode": "ERR01060",
  "ResponseData": {
    "ResponseID": "56876638"
  }
}