Card Handover\Sell card
CoreCard provides the facility of selling Gift cards from inventory and loaded with the amount as requested by the card purchaser. Purchaser information can also be captured/registered when gift cards are being sold as such cardholder information is not captured on gift cards.
PersonalizeCard
Action: POST
Endpoint: /api/PersonalizeCard
With the inventory of preprinted cards, a User may send a post request with card number, account number, or admin number along with the customer PII data, address information, ID, and other required details to update a card account's customer records and register it with the customer. This allows a customer to instantly receive a card.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required. Allowable Values: 16 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required. Allowable Values: 19 |
Title string Optional |
Title for the customer Valid Values: Refer Appendix Section : Title Values Example: Mr. Allowable Values: 9 |
FirstName string Mandatory |
Cardholder First Name Valid Values: A-Z, a-z Example: Andrew Allowable Values: 50 |
MiddleName string Optional |
Cardholder Middle Name Valid values are A-Z, a-z, 0-9 Example: Charles Allowable Values: 50 |
LastName string Mandatory |
Cardholder Last Name Valid values:A-Z, a-z Example: Hudson Allowable Values: 50 |
SecondLastName string Optional |
Second Last Name Valid values are A-Z, a-z, 0-9 Example: Test Allowable Values: 40 |
NameOnCard string Mandatory |
Name to be Embossed on Card Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles Allowable Values: 28 |
DateOfBirth datetime Mandatory |
Date of Birth of cardholder Format: MM/DD/YYYY Valid Values: 0-9 Example:- 03/26/1986 |
MotherMaidenName string Optional |
Mother’s Maiden Name Valid Values: A-Z,a-z Allowable Values: 40 |
CustomAccountID string Optional |
Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 Allowable Values: 25 |
AddressLine1 string Mandatory |
Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Allowable Values: 50 |
AddressLine2 string Optional |
Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Allowable Values: 50 |
Country string Mandatory |
This tag indicates the country of the cardholder. It should be 2 character code. Valid values :Valid values :A-Z, a-z Example: US Appendix Section: Country Code Values Allowable Values: 2 |
State string Mandatory |
Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US) Allowable Values: 3 |
City string Mandatory |
Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross Allowable Values: 25 |
PostalCode string Mandatory |
Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 Allowable Values: 10 |
HomePhoneCountryCode Int32 Optional |
Home Phone Country Code Valid Values: 0-9 Example: 91 Refer Appendix section : Phone Country Code Values |
HomePhoneNumber string Conditional |
Home Phone Number. Valid Values: 0-9 Example: 9812338769 Condition: Mandatory when WorkPhoneNumber or MobilePhoneNumber not provided Allowable Values: 10 |
HomePhoneExtension Int32 Optional |
Home Phone Number Extension Valid Values:0-9 Example:91 |
WorkPhoneCountryCode Int32 Optional |
Cardholder's work phone country code. Valid Values: 0-9 Example: 91 |
WorkPhoneNumber string Conditional |
Cardholder Work Phone Number Valid values:0-9 Example:9632581470 Condition:Mandatory when HomePhoneNumber or MobilePhoneNumber not provided Allowable Values: 10 |
WorkPhoneExtension Int32 Optional |
Cardholder's work phone extension code. Valid Values: 0-9 Example: 1589 |
MobilePhoneNumber string Conditional |
Cardholder's Mobile Phone Number Valid Values: 0-9 Example: 9876543210 Condition: Mandatory when HomePhoneNumber or WorkPhoneNumber not provided Allowable Values: 10 |
EmailAddress1 string Conditional |
E Mail Address 1 of Cardholder Valid Values: A-Z, a-z, 0-9 @ . Example: sem_pp1 @gmail.com Condition: If the validation parameter is set on the product for Primary Email Address then it will be mandatory. Allowable Values: 100 |
EmailAddress2 string Optional |
E Mail Address 2 of Card holder Valid Values: A-Z, a-z, 0-9 @ . Example : sem_pp1 @gmail.com Allowable Values: 100 |
SocialSecurityNumber string Mandatory |
Social Security Number of Cardholder Valid Values:0-9 Example:123456789 Condition:At least one of SocialSecurityNumber or IDName field should be passed in the input as Identification details. Allowable Values: 9 |
IDName string Conditional |
ID Code representing ID Name Valid Values: 0-9 Example 05 Condition:At least one of SocialSecurityNumber,or IDName field should be passed in the input as Identification details. Refer Appendix section : ID Name Values Allowable Values: 2 |
IDNumber string Conditional |
Last 4 Digits of Primary ID Valid Values: 0-9 Example: 4586 Condition : This field is mandatory when IDName is provided. Allowable Values: 18 |
IDDescription string Conditional |
Description of ID Valid Values: A-Z,a-z, 0-9. Condition:Field will be ignored in case of ID Name other than '13 - Other ID'. Allowable Values: 20 |
IDIssuingAuthority string Conditional |
ID Issuing Authority (country) Example : AE = United Arab Emirates Condition : This field is mandatory when IDName is provided. Allowable Values: 5 |
IDIssueState string Conditional |
ID Issue State Valid Values:A-Z,a-z Example:GA Appendix Section: Refer Appendix Section : State Codes (US) Condition : Mandatory when IDName is 07 and IDIssuingAuthority is US Allowable Values: 3 |
IDIssueDate datetime Conditional |
ID Issue Date Format: MM/DD/YYYY Valid Values:0-9 Example: 03/26/1998 Condition : Mandatory when IDName is 02 |
IDExpirationDate datetime Conditional |
Expiration date of ID. Format: MM/DD/YYYY Valid Values:0-9 Example:03/26/1998 Condition : Mandatory when IDName is 02 |
ShipToAddress string Optional |
Decision flag to decides address to ship a card. Valid Values: 2 : Same as Physical Primary Address 3 : Ship to Other Address Example: 2 Allowable Values: 2 |
ShipToFirstName string Conditional |
First Name for Shipping address Valid Values: A-Z,a-z. Example: TestName Condition : mandatory when ShipToAddress is 2 or 3 Allowable Values: 50 |
ShipToMiddleName string Optional |
Middle Name for Shipping address Valid Values: A-Z,a-z. Example: MName Allowable Values: 50 |
ShipToLastName string Conditional |
Last Name for Shipping address Valid Values: A-Z,a-z. Example: LastName Condition: mandatory when ShipToAddress is 2 or 3 Allowable Values: 50 |
ShipToAddressLine1 string Conditional |
Address Line 1 for Shipping address Valid values:A-Z, a-z, 0-9 Example: 1 Meca Way Condition: mandatory when ShipToAddress is 2 or 3 Allowable Values: 50 |
ShipToAddressLine2 string Optional |
Address Line 2 for Shipping address Valid values:A-Z, a-z, 0-9 Example:15 Penang Street Point Allowable Values: 50 |
ShipToCity string Conditional |
City for Shipping address Valid values:A-Z, a-z, 0-9 Example:Norcross Condition: mandatory when ShipToAddress is 2 or 3 Allowable Values: 25 |
ShipToState string Conditional |
State for Shipping address Valid Values:A-Z,a-z Example:NY Refer Appendix section : State Codes (US) Condition: mandatory when ShipToAddress is 2 or 3 Allowable Values: 3 |
ShipToCountry string Conditional |
Country Code for Shipping address Valid values are A-Z, a-z Example: US Refer Appendix section : Country Code Values Condition: mandatory when ShipToAddress is 2 or 3 Allowable Values: 2 |
ShipToPostalCode string Conditional |
ZIP code for Shipping address Valid values:A-Z, a-z,0-9 Example: 30093 Condition: mandatory when ShipToAddress is 2 or 3 Allowable Values: 10 |
UserFieldTitle1 string Optional |
Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: Test,1234,09102019 Allowable Values: 40 |
UserFieldTitle2 string Optional |
Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company Allowable Values: 40 |
UserFieldTitle3 string Optional |
Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company Allowable Values: 40 |
UserFieldTitle4 string Optional |
Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company Allowable Values: 40 |
UserFieldTitle5 string Optional |
Field to capture additional data from cardholder as per product setup Format in case of date: MMDDYYYY Valid Values:A-Z,a-z,0-9 Example: company Allowable Values: 40 |
CIPCheckConducted string Optional |
CIP Check is conducted on the card or not. Valid Values: 0 = Yes 1 = No Example : 1 Allowable Values: 1 |
GeneratePlastic byte Optional |
Flag to decide new plastic card number. Valid values: 0=Generates Additional card(Same Cardnumber), 1= Generates a new Card(Different Cardnumber). Condition: works after product configuration |
IsCardMasked string Optional |
Flag to indicate CardNumber should be returned in masked form or in clear form. Valid Values: 0= Card Number without Masked in Resonse. 1= Card Number with Masked in Resonse. 2= No Card Number in Resonse. Note : Default value is 0 Allowable Values: 1 |
LinkedAccountNumber string Optional |
To link an account with an existing account in the system. Valid values : Existing Account Number Example : 60000000009719 Allowable Values: 19 |
APIFunction string Conditional |
Status of card during LN/OFAC check Valid Values : 0 = Normal Sell / PersonaliseCard 1 = Sell / Personalise Card from release approve panel Example: 1 Allowable Values: 1 |
AddAndLoadWalletDetails array Optional |
|
LinkWithExistingCustomer Int32 Optional |
To link new account with existing customer using customer ID Valid Values: 0 = No(default) and 1 = Yes Format: x Example: 0=No, |
CustomerID string Conditional |
Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 Condition: Mandatory when 'Link With Existing Customer' = Yes Allowable Values: 25 |
Sample Request Body
{ "APIVersion": "1.4", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "4066836120006077", "ProxyNumber": "", "Title": "", "FirstName": "Mark", "MiddleName": "", "LastName": "smith", "SecondLastName": "", "NameOnCard": "", "DateOfBirth": "1986-03-26T00:00:00", "MotherMaidenName": "", "CustomAccountID": "", "AddressLine1": "AB", "AddressLine2": "CD", "Country": "US", "State": "GA", "City": "NoCross", "PostalCode": "34351", "HomePhoneCountryCode": 0, "HomePhoneNumber": "2569859685", "HomePhoneExtension": 0, "WorkPhoneCountryCode": 0, "WorkPhoneNumber": "2569859682", "WorkPhoneExtension": 0, "MobilePhoneNumber": "2569859681", "EmailAddress1": "harshalwaje8@mail.com", "EmailAddress2": "", "SocialSecurityNumber": "458968579", "IDName": "", "IDNumber": "", "IDDescription": "", "IDIssuingAuthority": "", "IDIssueState": "", "IDIssueDate": "2017-11-22T00:00:00", "IDExpirationDate": "2024-10-22T00:00:00", "ShipToAddress": "2", "ShipToFirstName": "Mark", "ShipToMiddleName": "", "ShipToLastName": "smith", "ShipToAddressLine1": "51 Cross Dew", "ShipToAddressLine2": "", "ShipToCity": "NoCross", "ShipToState": "GA", "ShipToCountry": "US", "ShipToPostalCode": "34567", "UserFieldTitle1": "", "UserFieldTitle2": "", "UserFieldTitle3": "", "UserFieldTitle4": "", "UserFieldTitle5": "", "CIPCheckConducted": "", "GeneratePlastic": 0, "IsCardMasked": "", "LinkedAccountNumber": "", "APIFunction": "", "AddAndLoadWalletDetails": [ { "WalletID": 1001, "WalletLoadAmount": 20.0 } ], "LinkWithExistingCustomer": 1, "CustomerID": "1031716" }
Response Fields Detail
Fields | Description |
---|---|
CardHolderName string |
Full Name of Cardholder. Example: Jacob B Jonas Allowable Values: 40 |
AccountNumber string |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Allowable Values: 19 |
CardNumber string |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Allowable Values: 16 |
ProxyNumber string |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Allowable Values: 19 |
DDANumber string |
DDA (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890 Allowable Values: 100 |
RoutingNumber string |
Bank Routing Number Valid Values:0-9 Example:0110000015 Allowable Values: 10 |
CustomAccountID string |
Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 Condition:Mandatory If Custom Account ID on product as Enabled. Allowable Values: 25 |
LNResultsGroup
|
LNResultsGroup |
OFACResultsGroup
|
OFACResultsGroup |
LexNexInquiryDate datetime |
Lexis Nexis Inquiry Date Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00 |
OFACInquiryDate datetime |
OFAC Inquiry Date Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00 |
OFACScore string |
Score received after OFAC Checks. Example : 2 |
SDNEntry1 string |
Value imposed to an Account after OFAC Check via third party Example:85 |
SDNEntry2 string |
Value imposed to an Account after OFAC Check via third party Example:85 |
SDNEntry3 string |
Value imposed to an Account after OFAC Check via third party Example:85 |
SDNEntry4 string |
Value imposed to an Account after OFAC Check via third party Example:85 |
SDNEntry5 string |
Value imposed to an Account after OFAC Check via third party Example:85 |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "CardHolderName": "Mark smith", "AccountNumber": "60000000031846", "CardNumber": "406683******6077", "ProxyNumber": "1316624", "DDANumber": "4726120006077", "RoutingNumber": "061120084", "CustomAccountID": "78545265", "LNResultsGroup": { "LexNexList": [ { "RiskCodes": "11: The input address may be invalid according to postal specifications" } ], "CVICheckValue": "10", "NASCheckValue": "4", "LexNexInquiryDate": "2024-08-31T00:00:00" }, "OFACResultsGroup": { "OFACInquiryDate": "2024-08-31T00:00:00", "OFACScore": "10", "SDNEntry1": "83", "SDNEntry2": "83", "SDNEntry3": "83", "SDNEntry4": "83", "SDNEntry5": "83" } } }