Category links

API Links

Update Portfolio ID

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/UpdatePortfolioID

Use this API to update the portfolio ID of a card account.

Request fields details
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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.

AccountNumber

string

Conditional

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

Allowable Values:

19

PortfolioID

string

Mandatory

Portfolio Id assigned on account Valid Values: Valid Portfolio ID value Format: XXXX Example: Midland Condition: This ID must be amongst the ID existing for the Institution (List received in Response of GetPortfolioIDMapping API)

Allowable Values:

50

ApplicationVersion

string

Optional

This Tag reflects the Application Version. Valid Values: 0-9 Example:2.0

Allowable Values:

3

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

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.

AccountNumber

string

Conditional

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

Allowable Values:

19

PortfolioID

string

Mandatory

Portfolio Id assigned on account Valid Values: Valid Portfolio ID value Format: XXXX Example: Midland Condition: This ID must be amongst the ID existing for the Institution (List received in Response of GetPortfolioIDMapping API)

Allowable Values:

50

ApplicationVersion

string

Optional

This Tag reflects the Application Version. Valid Values: 0-9 Example:2.0

Allowable Values:

3
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "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": "8000000000000011",
  "PortfolioID": "ha12",
  "ApplicationVersion": null
}
Response fields details
Fields Description

PlanSegmentID

string

Plan Segment ID for an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

10

InvoiceNumber

string

Incoice Number for Transaction. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

28

CollateralID

string

Collateral ID of an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:632563

Allowable Values:

10

EffectiveDate

datetime

This tag reflects the effective date of trnsaction Format:MMDDYYYY Example:01202020

ReasonCode

integer

Reason Code field for Error or Success of API. Valid Values:1/0 Format:X Example : 1,0

Memo

string

Note for each erroneous input. Two letter code Valid Values:A-Z,0-9 Format:ZZ Example:12.

Allowable Values:

100

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200

Allowable Values:

15

PlanSegmentID

string

Plan Segment ID for an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

10

InvoiceNumber

string

Incoice Number for Transaction. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

28

CollateralID

string

Collateral ID of an account. Valid Values: 0-9 Format:XXXXXXXXXX Example:632563

Allowable Values:

10

EffectiveDate

datetime

This tag reflects the effective date of trnsaction Format:MMDDYYYY Example:01202020

ReasonCode

integer

Reason Code field for Error or Success of API. Valid Values:1/0 Format:X Example : 1,0

Memo

string

Note for each erroneous input. Two letter code Valid Values:A-Z,0-9 Format:ZZ Example:12.

Allowable Values:

100

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200

Allowable Values:

15

Sample response body 

{
  "Message": "Collateral ID Updated Successfully.",
  "Status": true,
  "ErrorCode": "0",
  "ResponseData": {
    "PlanSegmentID": "101340",
    "InvoiceNumber": "170116014716699",
    "CollateralID": "ha12",
    "EffectiveDate": "01/16/2017 00:00:00",
    "ReasonCode": 1,
    "Memo": "Collateral ID Updated Successfully",
    "ResponseID": "56792591"
  }
}
POST /api/CoreCredit/AccountManagement/UpdatePortfolioID