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.
AVS Information Object avs_info Applicable to the US only. 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 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/ach 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.

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)

Vault Add ACH

Creates a new ACH profile. A data key is generated and returned to the merchant in the response.

ACH transactions are available to US integrations only.

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_add_ach:ach_info,order_id_102,john,416-555-5555,email,note,ppd,Bob,Smith,Address 1,Address2,Chicago,IL,123456,123456789,12345,101,savings 

us_res_add_ach:ach_info,order_id_103,john,416-555-5555,email,note,ppd,,,,,,,,123456789,12345,,savings 
Response Format:

//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_102,null,001,,null,11:21:32,2010-02-23,null,true,Successfully registered ACH details.,null,null,null,false,,,null,null,hqcRmOH0MnLFdNYUwkuHnERgS,ach,john, 416-555- 5555,email,note,,,,,,,,,ppd,Bob,Smith,Address 1,Address2,Chicago,IL,123456,123456789,***2345,101,savings 

order_id_103,null,001,,null,11:21:38,2010-02-23,null,true,Successfully registered ACH details.,null,null,null,false,,,null,null,9gf2ywY096nDWINLYfoXN6rLZ,ach,john, 416-555- 5555,email,note,,,,,,,,,ppd,,,,,,,,123456789,***2345,,savings


                

Vault Add ACH transaction 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.
ACH Info Object ach_info Refer below for further breakdown and definition.

Vault Add ACH transaction optional values

Value Type Limits Variable 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 String 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.

ACH Info mandatory values

Value Type Limits Variable Description
SEC Code String ppd/ccd/web sec ACH sec Code:
The following sec codes apply
ppd - Prearranged Payment and Deposit
ccd - Cash Concentration or Disbursement
web - Internet Initiated Entry
Routing Number String 9-character numeric routing_num The first number in the MICR, or magnetic ink character recognition, line at the bottom of a check is the bank's check routing number. It is exactly nine digits long and always starts with 0, 1, 2 or 3.
Account Number String 15-character alphanumeric account_num The account number may appear before or after the check number in the check's MICR line at the bottom of the check. The length of the account number varies with a maximum length of 50 digits.
Account Type String savings/checking account_type Identifies the type of bank account. The account type must be submitted as either ‘savings’ or ‘checking’. This field is case sensitive.

ACH Info optional values

Value Type Limits Variable Description
Customer First Name String 50-character alphanumeric cust_first_name Account holder's first name.
Customer Last Name String 50-character alphanumeric cust_last_name Account holder's last name.
Customer Address 1 String 50-character alphanumeric cust_address1 Account holder's address line 1.
Customer Address 2 String 50-character alphanumeric cust_address2 Account holder's address line 2.
Customer City String 50-character alphanumeric cust_city Account holder's city.
Customer State String 2-character alphanumeric cust_state The state must be submitted as exactly 2 characters (ex. MI – Michigan)
Customer Zip Code String 10-character numeric cust_zip Account holder's zipcode.
Check Number String 16-character alphanumeric check_num The sequential number for checks appears in both the MICR line at the bottom of the check and the upper right corner of the check. The check number length may vary; the maximum length is 16 digits.
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/ach 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.
ACH Fields
SEC Code 3-character numeric sec Returns the ACH SEC code saved in the profile.
Customer First Name 50-character alphanumeric cust_first_name Returns the customer first name saved in the profile.
Customer Last Name 50-character numeric cust_last_name Returns the customer last name saved in the profile.
Customer Address 1 50-character alphanumeric cust_address1 Returns the customer address line 1 saved in the profile.
Customer Address 2 50-character alphanumeric cust_address2 Returns the customer address line 2 saved in the profile.
Customer City 50-character alphanumeric cust_city Returns the customer city saved in the profile.
Customer State 2-character alphanumeric cust_state Returns the customer state code saved in the profile.
Customer Zip Code 10-character alphanumeric cust_zip Returns the customer zip code saved in the profile.
Check Routing Number 9-character alphanumeric routing_num Returns the customer check routing number saved in the profile.
Masked Account Number 15-character alphanumeric masked_account_num Returns the masked first 4 last 4 of the account number saved in the profile.
Check Number 16-character alphanumeric check_num Returns the check number saved in the profile.
Account Type savings/checking account_type Returns the type of account saved in the profile.

Predecessors
  • NA
Successors

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 all 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.

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 ACHInfo, will be overwritten.

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 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.
AVS Information Object Not applicable. avs_info Applicable to the US only. Refer below for further breakdown and definition.
AVS Information optional 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 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/ach 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.

Predecessors
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)

Vault Delete

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/ach 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.
ACH Fields
SEC Code 3-character numeric sec Returns the ACH SEC code saved in the profile.
Customer First Name 50-character alphanumeric cust_first_name Returns the customer first name saved in the profile.
Customer Last Name 50-character numeric cust_last_name Returns the customer last name saved in the profile.
Customer Address 1 50-character alphanumeric cust_address1 Returns the customer address line 1 saved in the profile.
Customer Address 2 50-character alphanumeric cust_address2 Returns the customer address line 2 saved in the profile.
Customer City 50-character alphanumeric cust_city Returns the customer city saved in the profile.
Customer State 2-character alphanumeric cust_state Returns the customer state code saved in the profile.
Customer Zip Code 10-character alphanumeric cust_zip Returns the customer zip code saved in the profile.
Check Routing Number 9-character alphanumeric routing_num Returns the customer check routing number saved in the profile.
Masked Account Number 15-character alphanumeric masked_account_num Returns the masked first 4 last 4 of the account number saved in the profile.
Check Number 16-character alphanumeric check_num Returns the check number saved in the profile.
Account Type savings/checking account_type Returns the type of account 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.

Predecessors
Successors
  • NA