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

Canada Code Sample

//Request Format:

res_add_cc,order_id,cust_id,phone,email,note,pan,exp_date,crypt_type

//Sample Request:

res_add_cc,mjr-res-add-210510-251-1,moneris,phone,email,note,4242424242424242,1111,7

//Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, reserved, reserved, reserved, reserved

//Sample Response:

mjr-res-add-210510-251-1,null,001,null,null,14:52:49,2010-05-21,null,true,Successfully registered CC details.,null,null,null,false,,,we3u5tak7ce4UPiy1xRnDqqju,cc,moneris,phone,email,note,4242***4242,1111,7,, ,,

                
USA Code Sample

//Request Format:

us_res_add_cc,order_id,cust_id,phone,email,note,pan,exp_date,crypt_type

us_res_add_cc:avs_info,order_id,cust_id,phone,email,note,pan,exp_date,crypt_type, avs_street_number,avs_street_name,avs_zipcode

//Sample Request:

us_res_add_cc,order_id_100,john,416-555-5555,email,note,4242424242424242,1111,7 

us_res_add_cc:avs_info,order_id_101,john,416-555-5555,email,note,4242424242424242,1010,7,999,Michigan Ave,M1M1M1

//Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, avs_street_number, avs_street_name, avs_zipcode, reserved, reserved, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_state, cust_zip, routing_num, account_num, check_num, account_type

//Sample Response:

order_id_100,null,001,,null,11:21:22,2010-02-23,null,true,Successfully registered CC details.,null,null,null,false,,,null,null,HKVjnDUUmdX6QjOkCWkgqMwgG,cc,john, 416-555- 5555,email,note,4242***4242,1111,7,,,,,,,,,,,,,,,,, 

order_id_101,null,001,,null,11:21:27,2010-02-23,null,true,Successfully registered CC details.,null,null,null,false,,,null,null,Qa9QZF3q2Fgo5s91polQFixaJ,cc,john, 416-555- 5555,email,note,4242***4242,1010,7,999,Michigan Ave,M1M1M1,,,,,,,,,,,,,,


                

Vault Add Credit Card mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id For Vault administrative transactions, the order ID is used as a way to tie the request to the response. This field is not stored on file for future reference.
Credit card number String 20-character alphanumeric pan Most credit card numbers today are 16 digits, but some 13-digit numbers are still accepted by some issuers. This field has been intentionally expanded to 20 digits in consideration for future expansion and potential support of private label card ranges.
Expiry Date String 4-character alphanumeric (YYMM format) expdate Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character numeric crypt_type 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

Vault Add Credit Card optional values

Value Type Limits Set method Description
Customer ID String 50-character alphanumeric 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.
Phone Number String 30-character alphanumeric phone Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Note String 30-character alphanumeric 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.
Email address String 30-character alphanumeric email Email address of the customer. Can be sent in when creating or updating a Vault profile.

Vault Response Fields

Value Limits Variable Description
Data Key 25-character alphanumeric DataKey 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 ResSuccess Indicates whether Vault transaction was successful.
PaymentType cc PaymentType Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric cust_id Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric phone Returns the phone number saved in the profile.
Email Address 30-character alphanumeric email Returns the email address saved in the profile.
Note 30-character alphanumeric note Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric masked_pan Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric expdate Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric crypt_type Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric avs_street_number 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 avs_street_name 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 avs_street_zipcode 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.

Vault Update Credit Card

Updates an existing Vault profile (referencing the profile's unique data key) with cardholder information.

Information contained within a credit card profile is updated as indicated by the submitted fields; if any field representing an item of cardholder information is not sent in this request, that item will remain unchanged in the profile.

If the Vault profile is being updated with a new credit card number, then you first need to send a Purchase, Pre-Authorization or Card Verification transaction, with the Credential on File Info object included, before performing Vault Update Credit Card. If the credit card number is not one of the profile items being updated, this step is not required.

Things to consider:

  • To update a specific element in the profile, set that element using the corresponding set method
  • When updating a credit card number, first send a Purchase, Pre-Authorization, or Card Verification with the Credential on File Info object before sending this transaction; send the issuer ID received in the response in the subsequent Vault Update Credit Card request
  • If the credit card number is not one of the profile items being updated, the Credential on File info object is not required

Canada Code Sample

Request Format:

res_update_cc,order_id,data_key,cust_id,phone,email,note,pan,exp_date,crypt_type

Sample Request:

res_update_cc,mjr-res-update-210510-251-1,moneris,phone,email,note,4242424242424242,1111,7

Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, reserved, reserved, reserved, reserved

Sample Response:

mjr-res-update-210510-251-1,null,001,null,null,14:52:49,2010-05-21,null,true,Successfully registered CC details.,null,null,null,false,,,we3u5tak7ce4UPiy1xRnDqqju,cc,moneris,phone,email,note,4242***4242,1111,7,, ,,
                
USA Code Sample

Request Format:

us_res_update_cc,order_id,data_key,cust_id,phone,email,note,pan,exp_date,crypt_type

us_res_update_cc:avs_info,order_id,cust_id,phone,email,note,pan,exp_date,crypt_type, avs_street_number,avs_street_name,avs_zipcode

Sample Request:

us_res_update_cc,order_id_100,john,416-555-5555,email,note,4242424242424242,1111,7 

us_res_update_cc:avs_info,order_id_101,john,416-555-5555,email,note,4242424242424242,1010,7,999,Michigan Ave,M1M1M1

Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, avs_street_number, avs_street_name, avs_zipcode, reserved, reserved, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_state, cust_zip, routing_num, account_num, check_num, account_type

Sample Response:

order_id_100,null,001,,null,11:21:22,2010-02-23,null,true,Successfully registered CC details.,null,null,null,false,,,null,null,HKVjnDUUmdX6QjOkCWkgqMwgG,cc,john, 416-555- 5555,email,note,4242***4242,1111,7,,,,,,,,,,,,,,,,, 

order_id_101,null,001,,null,11:21:27,2010-02-23,null,true,Successfully registered CC details.,null,null,null,false,,,null,null,Qa9QZF3q2Fgo5s91polQFixaJ,cc,john, 416-555- 5555,email,note,4242***4242,1010,7,999,Michigan Ave,M1M1M1,,,,,,,,,,,,,,


                

Vault Update Credit Card mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id For Vault administrative transactions, the order ID is used as a way to tie the request to the response. This field is not stored on file for future reference.
Data key String 25-character alphanumeric data_key The data key is generated by Moneris, and is returned to the merchant when the profile is first registered.
Vault Update Credit Card conditional values
Value Type Limits Variable Description
Credit card number String 20-character alphanumeric pan Most credit card numbers today are 16 digits, but some 13-digit numbers are still accepted by some issuers. This field has been intentionally expanded to 20 digits in consideration for future expansion and potential support of private label card ranges.
Expiry Date String 4-character alphanumeric (YYMM format) expdate Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character numeric crypt_type 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

Vault Update Credit Card optional values

Value Type Limits Set method Description
Customer ID String 50-character alphanumeric 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 Phone Number 30-character alphanumeric email Email address of the customer. Can be sent in when creating or updating a Vault profile.
Phone Number String 30-character alphanumeric phone Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Note String 30-character alphanumeric 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.

Vault Response Fields

Value Limits Variable Description
Data Key 25-character alphanumeric DataKey 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 ResSuccess Indicates whether Vault transaction was successful.
PaymentType cc PaymentType Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric cust_id Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric phone Returns the phone number saved in the profile.
Email Address 30-character alphanumeric email Returns the email address saved in the profile.
Note 30-character alphanumeric note Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric masked_pan Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric expdate Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric crypt_type Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric avs_street_number 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 avs_street_name 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 avs_street_zipcode 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.

Vault Delete Credit Card

Deletes an existing Vault profile of any type using the unique data key that was assigned when the profile was added.

It is important to note that after a profile is deleted, the information which was saved within can no longer be retrieved.

Canada Code Sample

Request Format:

res_delete,order_id,data_key

Sample Request:

res_delete,mjr-res-delete-210510-251-1,E08TCqdXsiOhDey9YZDa7QDMa

Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, reserved, reserved, reserved, reserved

Sample Response:

mjr-res-delete-210510-251-1,null,001,null,null,14:53:13,2010-05-21,null,true,Successfully deleted CC details.,null,null,null,false,,,E08TCqdXsiOhDey9YZDa7QDMa,cc,moneris,phone,email,note,4242***4242,1111,7,, ,,

                
USA Code Sample

Request Format:

us_res_add_ach:ach_info,order_id,cust_id,phone,email,note, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_zip, routing_num, account_num, check_num, account_type

Sample Request:

us_res_delete,order_id_104,COfxgha5Wb4lRG7sxpCKWQpRe

Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, avs_street_number, avs_street_name, avs_zipcode, reserved, reserved, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_state, cust_zip, routing_num, account_num, check_num, account_type

Sample Response:

order_id_104,null,001,,null,11:21:43,2010-02-23,null,true,Successfully deleted ACH details.,null,null,null,false,,,null,null,COfxgha5Wb4lRG7sxpCKWQpRe,ach,,,,,,,,,,,,,ppd,,,,,,,,123456789,8 574***9829,123,checking


                

Vault Delete mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric order_id For Vault administrative transactions, the order ID is used as a way to tie the request to the response. This field is not stored on file for future reference.
Data key String 25-character alphanumeric data_key Profile identifier that all future financial Vault transactions (that is, they occur after the profile was registered by a Vault Add Credit Card or Vault Tokenize Credit Card transaction, for example) 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.
Vault Response Fields
Value Limits Variable Description
Data Key 25-character alphanumeric DataKey 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 ResSuccess Indicates whether Vault transaction was successful.
PaymentType cc PaymentType Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric cust_id Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric phone Returns the phone number saved in the profile.
Email Address 30-character alphanumeric email Returns the email address saved in the profile.
Note 30-character alphanumeric note Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric masked_pan Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric expdate Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric crypt_type Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric avs_street_number 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 avs_street_name 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 avs_street_zipcode 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.