Category links

API Links

Update Shipping Address

Action: POST

Endpoint: /api/CoreCredit/CardManagement/UpdateShippingAddress

Use this API to update the shipping address and physical card delivery options on an existing customer record. CoreCARD uses the shipping address and delivery options when a physical card is to be delivered to a cardholder.

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

Mandatory

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:12345

CardSequenceNumber

integer

Mandatory

Card Sequence Number.Physical Card order can be uniquely identify by combination of Admin Number and Card Sequence Number. Valid Values:0-9 Example: 1

ShippingAddressLine1

string

Mandatory

Shipping address line 1. Example: 2354 Main road Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingAddressLine2

string

Optional

Shipping address line 2. Example:xyz Avenue Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingCity

string

Mandatory

Shipping address city name. Example: chicago Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

25

ShippingState

string

Mandatory

Sate of the shipping address. Example:AK(Alaska) Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

30

ShippingCountry

string

Mandatory

Shipping address Country name. Example:US(United States) Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

5

ShippingPostalCode

string

Mandatory

Zip code of the shipping address. Example:12345 Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

NameOnCard

string

Mandatory

Name to be Embossed on Card. Example: John K Peter Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

IsPermanentAddress

integer

Mandatory

Flag to mark permanent address same as mailing address. Valid Values: 0 - No, 1- Yes Example: 1

DeliveryMechanism

string

Mandatory

Shipment delivery mechanism. Valid Values: 0 = Standard 1 = Priority 2 = Overnight 3=Standard Exp 4=Priority Exp 5=Overnight Exp Example: 0 Condition:Values 3,4,5 are only applicable for Perfect Plastic Card Vendor

Allowable Values:

9

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,
  "AdminNumber": 129427,
  "CardSequenceNumber": 1,
  "ShippingAddressLine1": "145 Stree 1",
  "ShippingAddressLine2": "Park Avenue",
  "ShippingCity": "Chicago",
  "ShippingState": "AK",
  "ShippingCountry": "US",
  "ShippingPostalCode": "12345",
  "NameOnCard": "John k Peter",
  "IsPermanentAddress": 1,
  "DeliveryMechanism": "0"
}
Response fields details
Fields Description

Sample response body

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