Category links

API Links

Get Welcome Package URL

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetWelcomePackageURL

Use this API to retrieve the welcome package URL for an account holder by providing the account number or application ID.

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

AccountNumber

string

Conditional

This tag reflects the Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: Either Account Number or Application ID must be provided.

Allowable Values:

19

ApplicationID

int64

Conditional

Details can be obtained by Application ID. Either Account Number or Application ID must be provided. Valid Values: 0-9 Format: XXXXXXXXXX Example: 1234569875 Condition: Either Account Number or Application ID must be provided.

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,
  "AccountNumber": "8000000000000169",
  "ApplicationID": null
}
Response fields details
Fields Description

WelcomePackURL

string

Hyperlink to receive the welcome package Valid Values: valid hyperlink Format: http://XXXXXXXXXX Example: http://creditdev2:8081/Application/Agreement?Auth=78AF2D2C773DEF76073A9E77360E334B1CB1DE76239FD85DF760266731F504B653EAA183E829D8DA|C2343C101A18B35396774F39D479674A

Allowable Values:

250

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,a-z Format: xxx Example: 200

Allowable Values:

15

Sample response body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "WelcomePackURL": "https://creditdev2:8081/Application/Agreement?Auth=78AF2D2C773DEF76073A9E77360E334B1CB1DE76239FD85DF760266731F504B653EAA183E829D8DA|C2343C101A18B35396774F39D479674A",
    "ResponseID": "56882604"
  }
}
POST /api/CoreCredit/AccountManagement/GetWelcomePackageURL