GetEmbossingDetails
Action: POST
Endpoint: /api/CoreCredit/CardManagement/GetEmbossingDetails
This API is used to transfer the embossing details to the client on 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 |
AccountNumber string Optional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
CardNumber string Conditional |
Card Number of cardholder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Allowable Values: 19 |
AdminNumber int64 Conditional |
Admin number is a unique identifier of card in the system ,returned in the response of Account creation. Valid Values:0-9 Format:XXXXX Example:12345 |
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": null, "CardNumber": null, "AdminNumber": 129419 }
Response fields details
Fields | Description |
---|---|
AccountNumber string |
Cardholder Account number. Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
AdminNumber int64 |
Admin number is a unique identifier of card in the system ,returned in the response of Account creation. Valid Values:0-9 Format:XXXXX Example:12345 |
CardNumber string |
Card Number of cardholder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Allowable Values: 19 |
CardLast4Digit string |
Last 4 digits of card number Valid Values:0-9 Format:XXXX Example:1234 Allowable Values: 4 |
CardSequenceNumber integer |
This tag reflects the Sequence Number of the Card. Example: 2 |
CardExpirationDate string |
Date on which card will expire. Valid Values: 0-9 Format: MMYY Example:0121 Allowable Values: 4 |
NameOnCard string |
Name to be printed on the card. Valid Values:A-Z, 0-9 Example: John J Allowable Values: 50 |
Title string |
Title of the cardholder. Format: A-Z Example: Mr Allowable Values: 10 |
FirstName string |
Cardholder First name. Valid Values:A-Z Example:User1 Allowable Values: 30 |
MiddleName string |
Cardholder Middle Name Valid Values:A-Z Example: LEE Allowable Values: 30 |
LastName string |
Cardholder last name. Valid Values:A-Z Example:Smith Allowable Values: 30 |
AddressLine1 string |
Cardholder address line 1. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
AddressLine2 string |
Cardholder address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Allowable Values: 50 |
City string |
This tag reflects the City name of the cardholder address. Example:Los Angeles Allowable Values: 10 |
State string |
State of cardholder address Valid Values: a-z Format:XXX Example:MO Allowable Values: 5 |
PostalCode string |
Postal code of the cardholder address. Valid Values: 0-9 Format:XXXXX Example:46206 Allowable Values: 5 |
Country string |
Country name of the cardholder address Example:USA Allowable Values: 10 |
CompanyName string |
Company Name Valid Values:A-Z,0-9 Example: Company LLC Allowable Values: 30 |
CreditLimit decimal |
Credit Limit of account Valid Values:0-9 Format:XXX.XX Example:500.00 |
CashLimit decimal |
CashLimit Valid Values:0-9 Format:XXX.XX Example:500.00 |
CVC string |
3 digit number used in certain transactions. Valid Values:0-9 Format:XXX Example:018 Allowable Values: 3 |
CVV2 string |
3 digit number used in transaction and printed on back of the card. Valid Values:0-9 Format:XXX Example:788 Allowable Values: 3 |
iCVV string |
3 digit security number used in some transactions. Valid Values:0-9 Format:XXX Example:285 Allowable Values: 3 |
PIN string |
Personal Identification Number of Card Valid Values: 0-9 Format:XXXX Example:2014 Allowable Values: 4 |
PinOffset string |
PinOffset Valid Values: 0-9 Format:XXXX Example:2014 Allowable Values: 4 |
Track1Data string |
Track1Data Valid Values: 0-9,a-z Format:XXXX Example:B5288981432934738^LAST/FIRST^22012010101839350000000000 Allowable Values: 100 |
Track2Data string |
Track2Data Valid Values: 0-9,a-z Format:XXXX Example:5288981432934738=22012010101839350000 Allowable Values: 100 |
Track2EquivalentData string |
Track2EquivalentData Valid Values: 0-9,a-z Format:XXXX Example:5288981432934738=22012010100039350000 Allowable Values: 100 |
ActivationCode string |
Code which is provided at the time of Account Creation/Registration, should be passed as a user validation. Example: 123456 Allowable Values: 50 |
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: 20 |
Track1DiscretionaryData string |
Track1 Discretionary Data Example:0152624720000000000 Allowable Values: 100 |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "AccountNumber": "9000000500000311", "AdminNumber": 129567, "CardNumber": "5288980515107907", "CardLast4Digit": "7907", "CardSequenceNumber": 1, "CardExpirationDate": "2201", "NameOnCard": "first12 last12", "Title": null, "FirstName": "first12", "MiddleName": null, "LastName": "last12", "AddressLine1": "lineone", "AddressLine2": "linetwo", "City": "city", "State": "AK", "PostalCode": "456201", "Country": "US", "CompanyName": "Joe", "CreditLimit": 50000.0, "CashLimit": 0.0, "CVC": "199", "CVV2": "551", "iCVV": "337", "PIN": "0938", "PinOffset": "0938", "Track1Data": "B5288980515107907^LAST12/FIRST12^22012010119909380000000000", "Track2Data": "5288980515107907=22012010119909380000", "Track2EquivalentData": "5288980515107907=22012010100009380000", "ActivationCode": "fc444d5a3faf45d0ac97b204474a47bf", "ResponseID": "56891588", "Track1DiscretionaryData": "0152624720000000000" } }