My Profile_


Encrypted Vault Add Credit Card

Creates a new credit card profile, and generates a unique data key which can be obtained from the Receipt object.

This data key is the profile identifier that all future financial Vault transactions will use to associate with the saved information

This transaction allows for the ability to swipe or key in data into a Moneris-provided encrypted MSR device and pass the encrypted track 2 value to process a card not present transaction.

Canada Code Sample

package Canada;

import JavaAPI.*;

public class TestCanadaEncResAddCC
{
	public static void main(String args[])
	{
		String store_id = "moneris";
		String api_token = "hurgle";

		String enc_track2 = "02D901801F4F2800039B%*4924********3428^TESTCARD/MONERIS^*****************************************?*;4924********3428=********************?*9AC1D386E03D553ACB8976E58653B76386B5C7ACBFA126D6ADC026018152893229626E03BE0D41673C975B69C773FDE3A890AD2B5452B02739529B85C8231B3798AEE7E702280CC8A3E4B3CE1C098E4CB24A0A7DFF462507E3419EFF3880E9D52C869BA6C970C49B10B3C6E146B626EDBB13F3C6057377E43CD06F7A188D84EA0260832F743E485C0D369929D4840FFAFA12BC3938C4A4DE4FA3FA837D1C2190FFFF314159200420005F345603";
		String device_type = "idtech_bdk";
		String phone = "55555555555";
		String email = "test.user@moneris.com";
		String note = "my note";
		String cust_id = "customer2";
		String crypt = "7";
		String processing_country_code = "CA";
		
		AvsInfo avsCheck = new AvsInfo();

		avsCheck.setAvsStreetNumber("212");
		avsCheck.setAvsStreetName("Payton Street");
		avsCheck.setAvsZipcode("M1M1M1");

		EncResAddCC enc_res_add_cc = new EncResAddCC ();
		enc_res_add_cc.setEncTrack2(enc_track2);
		enc_res_add_cc.setDeviceType(device_type);
		enc_res_add_cc.setCryptType(crypt);
		enc_res_add_cc.setCustId(cust_id);
		enc_res_add_cc.setPhone(phone);
		enc_res_add_cc.setEmail(email);
		enc_res_add_cc.setNote(note);
		//enc_res_add_cc.setAvsInfo(avsCheck);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(enc_res_add_cc);
		mpgReq.send();
		
		try
		{

			Receipt receipt = mpgReq.getReceipt();

			System.out.println("DataKey = " + receipt.getDataKey());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("ResSuccess = " + receipt.getResSuccess());
			System.out.println("PaymentType = " + receipt.getPaymentType() + "\n");

			//Contents of ResolveData
			System.out.println("Cust ID = " + receipt.getResCustId());
			System.out.println("Phone = " + receipt.getResPhone());
			System.out.println("Email = " + receipt.getResEmail());
			System.out.println("Note = " + receipt.getResNote());
			System.out.println("MaskedPan = " + receipt.getResMaskedPan());
			System.out.println("Exp Date = " + receipt.getResExpDate());
			System.out.println("Crypt Type = " + receipt.getResCryptType());
			System.out.println("Avs Street Number = " + receipt.getResAvsStreetNumber());
			System.out.println("Avs Street Name = " + receipt.getResAvsStreetName());
			System.out.println("Avs Zipcode = " + receipt.getResAvsZipcode());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
} 

                
USA Code Sample

package USA;

import JavaAPI.*;

public class TestUSAEncResAddCC
{
	public static void main(String args[])
	{
		String store_id = "monusqa002";
		String api_token = "qatoken";

		String enc_track2 = "02D901801F4F2800039B%*4924********3428^TESTCARD/MONERIS^*****************************************?*;4924********3428=********************?*9AC1D386E03D553ACB8976E58653B76386B5C7ACBFA126D6ADC026018152893229626E03BE0D41673C975B69C773FDE3A890AD2B5452B02739529B85C8231B3798AEE7E702280CC8A3E4B3CE1C098E4CB24A0A7DFF462507E3419EFF3880E9D52C869BA6C970C49B10B3C6E146B626EDBB13F3C6057377E43CD06F7A188D84EA0260832F743E485C0D369929D4840FFAFA12BC3938C4A4DE4FA3FA837D1C2190FFFF314159200420005F345603";
		String device_type = "idtech";
		String phone = "55555555555";
		String email = "test.user@moneris.com";
		String note = "my note";
		String cust_id = "customer2";
		String crypt = "7";
		String processing_country_code = "US";

		AvsInfo avsCheck = new AvsInfo();

		avsCheck.setAvsStreetNumber("212");
		avsCheck.setAvsStreetName("Payton Street");
		avsCheck.setAvsZipcode("M1M1M1");

		EncResAddCC resAddCC = new EncResAddCC();
		resAddCC.setEncTrack2(enc_track2);
		resAddCC.setDeviceType(device_type);
		resAddCC.setCryptType(crypt);		
		resAddCC.setCustId(cust_id);
		resAddCC.setPhone(phone);
		resAddCC.setEmail(email);
		resAddCC.setNote(note);
		//usResAddCC.setAvsInfo(avsCheck);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(resAddCC);
		mpgReq.send();

		try
		{
			Receipt receipt = mpgReq.getReceipt();

			System.out.println("DataKey = " + receipt.getDataKey());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("ResSuccess = " + receipt.getResSuccess());
			System.out.println("PaymentType = " + receipt.getPaymentType() + "\n");

			//Contents of ResolveData
			System.out.println("Cust ID = " + receipt.getResCustId());
			System.out.println("Phone = " + receipt.getResPhone());
			System.out.println("Email = " + receipt.getResEmail());
			System.out.println("Note = " + receipt.getResNote());
			System.out.println("MaskedPan = " + receipt.getResMaskedPan());
			System.out.println("Exp Date = " + receipt.getResExpDate());
			System.out.println("Crypt Type = " + receipt.getResCryptType());
			System.out.println("Avs Street Number = " + receipt.getResAvsStreetNumber());
			System.out.println("Avs Street Name = " + receipt.getResAvsStreetName());
			System.out.println("Avs Zipcode = " + receipt.getResAvsZipcode());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                

Encrypted Vault Add Credit Card transaction object definition

EncResAddCC resAddCC = new EncResAddCC();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(resAddCC);

Encrypted Vault Add Credit Card transaction object mandatory values

VALUE TYPE LIMITS SET METHOD DESCRIPTION
Encrypted Track 2 data String   resAddCC.setEncTrack2 (enc_track2); String that is retrieved by swiping or keying in a credit card number through a Moneris-provided encrypted mag swipe card reader. It is part of an encrypted keyed or swiped transaction only. This string must be retrieved by a specific device. (See Device Type below for the list of current available devices.)
Device Type String 30 – character alphanumeric resAddCC.setDeviceType (device_type); Type of encrypted mag swipe reader that was used to read the credit card. This must be a Moneris-provided device so that the values are properly encrypted and decrypted. This field is case-sensitive. Available values are: ·         "idtech" – applicable to US ·         "idtech_bdk" – applicable to Canada
E-Commerce indicator String 1-character numeric resAddCC.setCryptType(crypt); Supported values: 1: Mail Order / Telephone Order—Single
2: Mail Order / Telephone Order—Recurring
3: Mail Order / Telephone Order—Instalment
4: Mail Order / Telephone Order—Unknown classification
5: Authenticated e-commerce transaction (VBV)
6: Non-authenticated e-commerce transaction (VBV)
7: SSL-enabled merchant
8: Non-secure transaction (web- or email-based)
9: SET non-authenticated transaction

Encrypted Vault Add Credit Card transaction object optional values

VALUE TYPE LIMITS SET METHOD DESCRIPTION
Customer ID String 50-character alphanumeric resAddCC.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number and so on.

This field is searchable from the Moneris Merchant Resource Centre.
Email address String 30-character alphanumeric resAddCC.setEmail(email); Email address of the customer. Can be sent in when creating or updating a Vault profile.
Phone Number String 30-character alphanumeric resAddCC.setPhone(phone); Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Note String 30-character alphanumeric resAddCC.setNote(note); This optional field can be used for supplementary information to be sent in with the transaction. This field can be sent in when creating or updating a Vault profile.
AVS Information Object   AvsInfo avsCheck = new AvsInfo();
resAddCC.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.

AvsInfo mandatory values

VALUE TYPE LIMITS VARIABLE DESCRIPTION
AVS street number String 19-character alphanumeric1 avs_street_number Cardholder street number.
AVS street name String See AVS street number avs_street_name Cardholder street name.
AVS zip/postal code String 9-character alphanumeric avs_zipcode Cardholder zip/postal code

Vault Response Fields

VALUE LIMITS GET METHOD DESCRIPTION
Data Key 25-character alphanumeric receipt.getDataKey(); This field is created when a profile is created and a token is returned. 
It is a unique profile identifier, and is a required value for all future Vault transactions.
Vault Success true/false receipt.getResSuccess(); Indicates whether Vault transaction was successful.
Payment Type cc/ach receipt.getPaymentType(); Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric receipt.getResCustId(); Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric receipt.getResPhone(); Returns the phone number saved in the profile.
Email Address 30-character alphanumeric receipt.getResEmail(); Returns the email address saved in the profile.
Note 30-character alphanumeric receipt.getResNote(); Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric receipt.getResMaskedPan(); Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric receipt.getResExpdate(); Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric receipt.getResCryptType(); Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric receipt.getResAvsStreetNumber(); Returns the AVS street number saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Street Name 19-character alphanumeric receipt.getResAvsStreetName(); Returns the AVS street name saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Zip/Postal Code 9-character alphanumeric receipt.getResAvsZipcode(); Returns the AVS zip/postal code saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.

Predecessors
  • None
Successors
  • Vault Purchase Credit Card (API | Batch)
  • Vault Pre-Authorization Credit Card (API | Batch)
  • Vault Independent Refund Credit Card (API | Batch)
  • Vault Card Verification (API)
  • Vault Update Credit Card (API | Batch | Hosted Vault)
  • Vault Encrypted Update Credit Card (API)
  • Vault 3-D Secure (API)
  • Vault Look Up Full (API)
  • Vault Look Up Masked (API)
  • Vault Delete (API | Batch)

Encrypted Vault Update Credit Card

Updates a Vault profile (based on the data key) to contain credit card information. All information contained within a credit card profile is updated as indicated by the submitted fields.

This will update a profile to contain Credit Card information by referencing the profile’s unique data_key. If the profile which is being updated was already a Credit Card profile, all information contained within it will simply be updated as indicated by the submitted fields. This means that most fields are optional, and only those fields that are submitted will be updated.

If however the profile was of a different payment type (ie: ACH), the old profile will be deactivated and the new Credit Card information will be associated with the data_key. As a result, the mandatory fields for creating a new Credit Card profile will be required. These fields have been listed as conditional.

This transaction allows for the ability to swipe or key in data into a Moneris-provided encrypted MSR device and pass the encrypted track 2 value to process a card not present transaction.

Things to consider:

  • To update a specific field on the profile, only set that specific element using the corresponding set method.
  • If the Vault profile currently contains ACH payment details, then this transaction will update the token to contain Credit Card payment details and all ACH specific data, such as ACH Info, will be overwritten.
  • As the encrypted track 2 value will contain both the card number and expiry date, both of the values will be updated by this transaction and are therefore mandatory for this transaction.
  • If not looking to update the card number on the vault profile, please refer to the Vault Update Credit Card available in the standard Vault API transaction set.

Canada Code Sample

package Canada;
import JavaAPI.*;

public class TestCanadaEncResUpdateCC
{
	public static void main(String args[])
	{
		String store_id = "store1";
		String api_token = "yesguy";

		String data_key = "PHTM1pun7VOaSCFM2xdeP2Sim";
		String enc_track2 = "02D901801F4F2800039B%*4924********3428^TESTCARD/MONERIS^*****************************************?*;4924********3428=********************?*9AC1D386E03D553ACB8976E58653B76386B5C7ACBFA126D6ADC026018152893229626E03BE0D41673C975B69C773FDE3A890AD2B5452B02739529B85C8231B3798AEE7E702280CC8A3E4B3CE1C098E4CB24A0A7DFF462507E3419EFF3880E9D52C869BA6C970C49B10B3C6E146B626EDBB13F3C6057377E43CD06F7A188D84EA0260832F743E485C0D369929D4840FFAFA12BC3938C4A4DE4FA3FA837D1C2190FFFF314159200420005F345603";
		String device_type = "idtech_bdk";
		String phone = "55555555555";
		String email = "test.user@moneris.com";
		String note = "my note";
		String cust_id = "customer2";
		String crypt = "7";
		String processing_country_code = "CA";

		AvsInfo avsinfo = new AvsInfo();

		avsinfo.setAvsStreetNumber("212");
		avsinfo.setAvsStreetName("Smith Street");
		avsinfo.setAvsZipcode("M1M1M1");

		EncResUpdateCC enc_res_update_cc = new EncResUpdateCC ();
		enc_res_update_cc.setDataKey(data_key);
		enc_res_update_cc.setAvsInfo(avsinfo);		
		enc_res_update_cc.setCustId(cust_id);
		enc_res_update_cc.setEncTrack2(enc_track2);
		enc_res_update_cc.setDeviceType(device_type);
		enc_res_update_cc.setPhone(phone);
		enc_res_update_cc.setEmail(email);
		enc_res_update_cc.setNote(note);
		enc_res_update_cc.setCryptType(crypt);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(enc_res_update_cc);
		mpgReq.send();

		try
		{
			Receipt receipt = mpgReq.getReceipt();

			System.out.println("DataKey = " + receipt.getDataKey());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("ResSuccess = " + receipt.getResSuccess());
			System.out.println("PaymentType = " + receipt.getPaymentType() + "\n");

			//Contents of ResolveData
			System.out.println("Cust ID = " + receipt.getResCustId());
			System.out.println("Phone = " + receipt.getResPhone());
			System.out.println("Email = " + receipt.getResEmail());
			System.out.println("Note = " + receipt.getResNote());
			System.out.println("MaskedPan = " + receipt.getResMaskedPan());
			System.out.println("Exp Date = " + receipt.getResExpDate());
			System.out.println("Crypt Type = " + receipt.getResCryptType());
			System.out.println("Avs Street Number = " + receipt.getResAvsStreetNumber());
			System.out.println("Avs Street Name = " + receipt.getResAvsStreetName());
			System.out.println("Avs Zipcode = " + receipt.getResAvsZipcode());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                
USA Code Sample

package USA;
import JavaAPI.*;

public class TestUSAEncResUpdateCC
{
	public static void main(String args[])
	{
		String store_id = "monusqa002";
		String api_token = "qatoken";

		String data_key = "fEp6v0P0OrtsxH3SJV1WJYtDq";
		String enc_track2 = "02D901801F4F2800039B%*4924********3428^TESTCARD/MONERIS^*****************************************?*;4924********3428=********************?*9AC1D386E03D553ACB8976E58653B76386B5C7ACBFA126D6ADC026018152893229626E03BE0D41673C975B69C773FDE3A890AD2B5452B02739529B85C8231B3798AEE7E702280CC8A3E4B3CE1C098E4CB24A0A7DFF462507E3419EFF3880E9D52C869BA6C970C49B10B3C6E146B626EDBB13F3C6057377E43CD06F7A188D84EA0260832F743E485C0D369929D4840FFAFA12BC3938C4A4DE4FA3FA837D1C2190FFFF314159200420005F345603";
		String device_type = "idtech";
		String phone = "55555555555";
		String email = "test.user@moneris.com";
		String note = "my note";
		String cust_id = "customer2";
		String crypt = "7";
		String processing_country_code = "US";
		
		AvsInfo avsinfo = new AvsInfo();

		avsinfo.setAvsStreetNumber("212");
		avsinfo.setAvsStreetName("Smith Street");
		avsinfo.setAvsZipcode("M1M1M1");

		EncResUpdateCC enc_res_update_cc = new EncResUpdateCC ();
		enc_res_update_cc.setDataKey(data_key);
		enc_res_update_cc.setAvsInfo(avsinfo);
		enc_res_update_cc.setCustId(cust_id);
		enc_res_update_cc.setEncTrack2(enc_track2);
		enc_res_update_cc.setDeviceType(device_type);
		enc_res_update_cc.setPhone(phone);
		enc_res_update_cc.setEmail(email);
		enc_res_update_cc.setNote(note);
		enc_res_update_cc.setCryptType(crypt);

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(enc_res_update_cc);
		mpgReq.send();
		
		try
		{
			Receipt receipt = mpgReq.getReceipt();

			System.out.println("DataKey = " + receipt.getDataKey());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("ResSuccess = " + receipt.getResSuccess());
			System.out.println("PaymentType = " + receipt.getPaymentType() + "\n");

			//Contents of ResolveData
			System.out.println("Cust ID = " + receipt.getResCustId());
			System.out.println("Phone = " + receipt.getResPhone());
			System.out.println("Email = " + receipt.getResEmail());
			System.out.println("Note = " + receipt.getResNote());
			System.out.println("MaskedPan = " + receipt.getResMaskedPan());
			System.out.println("Exp Date = " + receipt.getResExpDate());
			System.out.println("Crypt Type = " + receipt.getResCryptType());
			System.out.println("Avs Street Number = " + receipt.getResAvsStreetNumber());
			System.out.println("Avs Street Name = " + receipt.getResAvsStreetName());
			System.out.println("Avs Zipcode = " + receipt.getResAvsZipcode());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

                

Encrypted Vault Update Credit Card transaction object definition

EncResUpdateCC enc_res_update_cc = new EncResUpdateCC ();

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(enc_res_update_cc);

Encrypted Vault Update Credit Card transaction object mandatory values

VALUE TYPE LIMITS SET METHOD DESCRIPTION
Data key String 25-character alphanumeric enc_res_update_cc.setData(data_key); Profile identifier that all future financial Vault transactions (that is, they occur after the profile was registered by a ResAddCC or ResTokenizeCC transaction) will use to associate with the saved information.

The data key is generated by Moneris, and is returned to the merchant (via the Receipt object) when the profile is first registered.
Encrypted Track 2 data String   enc_res_update_cc.setEncTrack2 (enc_track2); String that is retrieved by swiping or keying in a credit card number through a Moneris-provided encrypted mag swipe card reader. It is part of an encrypted keyed or swiped transaction only. This string must be retrieved by a specific device. (See Device Type below for the list of current available devices.)
Device Type String 30 – character alphanumeric enc_res_update_cc.setDeviceType (device_type); Type of encrypted mag swipe reader that was used to read the credit card. This must be a Moneris-provided device so that the values are properly encrypted and decrypted. This field is case-sensitive. Available values are: ·         "idtech" – applicable to US ·         "idtech_bdk" – applicable to Canada

Encrypted Vault Update Credit Card transaction object conditional values

VALUE TYPE LIMITS SET METHOD DESCRIPTION
E-commerce indicator String 1-character alphanumeric enc_res_update_cc.setCryptType(crypt_type); If changing an existing vault profile from ACH to Credit Card then this field is mandatory, otherwise optional. E-commerce indicatory, possible values: 1: Mail Order / Telephone Order—Single
2: Mail Order / Telephone Order—Recurring
3: Mail Order / Telephone Order—Instalment
4: Mail Order / Telephone Order—Unknown classification
5: Authenticated e-commerce transaction (VBV)
6: Non-authenticated e-commerce transaction (VBV)
7: SSL-enabled merchant
8: Non-secure transaction (web- or email-based)
9: SET non-authenticated transaction

Encrypted Vault Update Credit Card transaction object optional values

VALUE TYPE LIMITS SET METHOD DESCRIPTION
Customer ID String 50-character alphanumeric enc_res_update_cc.setCustId(cust_id); This can be used for policy number, membership number, student ID, invoice number and so on.

This field is searchable from the Moneris Merchant Resource Centre.
Email address String 30-character alphanumeric enc_res_update_cc.setEmail(email); Email address of the customer. Can be sent in when creating or updating a Vault profile.
Phone number String 30-character alphanumeric enc_res_update_cc.setPhone(phone); Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Note String 30-character alphanumeric enc_res_update_cc.setNote(note); This optional field can be used for supplementary information to be sent in with the transaction. This field can be sent in when creating or updating a Vault profile.
AVS information Object   AvsInfo avsCheck = new AvsInfo();
enc_res_update_cc.setAvsInfo(avsCheck);
Refer below for further breakdown and definition.

AvsInfo optional values

VALUE TYPE LIMITS VARIABLE DESCRIPTION
AVS street number String 19-character alphanumeric1 avs_street_number Cardholder street number.  Value may be set to blank which will remove any AVS street number currently on file. If no need to update this field then do not set.
AVS street name String See AVS street number avs_street_name Cardholder street name. Value may be set to blank which will remove any AVS street name currently on file. If no need to update this field then do not set.
AVS zip/postal code String 9-character alphanumeric avs_zipcode Cardholder zip/postal code. Value may be set to blank which will remove any AVS zip/postal code currently on file. If no need to update this field then do not set.

Vault Response Fields

VALUE LIMITS GET METHOD DESCRIPTION
Data Key 25-character alphanumeric receipt.getDataKey(); This field is created when a profile is created and a token is returned. 
It is a unique profile identifier, and is a required value for all future Vault transactions.
Vault Success true/false receipt.getResSuccess(); Indicates whether Vault transaction was successful.
Payment Type cc/ach receipt.getPaymentType(); Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric receipt.getResCustId(); Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric receipt.getResPhone(); Returns the phone number saved in the profile.
Email Address 30-character alphanumeric receipt.getResEmail(); Returns the email address saved in the profile.
Note 30-character alphanumeric receipt.getResNote(); Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric receipt.getResMaskedPan(); Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric receipt.getResExpdate(); Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric receipt.getResCryptType(); Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric receipt.getResAvsStreetNumber(); Returns the AVS street number saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Street Name 19-character alphanumeric receipt.getResAvsStreetName(); Returns the AVS street name saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Zip/Postal Code 9-character alphanumeric receipt.getResAvsZipcode(); Returns the AVS zip/postal code saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.

Predecessors
  • Vault Add Credit Card (API | Batch | Hosted Vault)
  • Encrypted Vault Add Credit Card (API)
  • Vault Add Token (API)
  • Vault Tokenize Credit Card (API)
Successors