My Profile_


Purchase

A Purchase verifies funds on the customer’s card, removes the funds and prepares them for deposit into the merchant’s account.

Canada Code Sample

//Request Format:

purchase, order_id, amount, pan, exp_date, crypt_type

purchase_supp, order_id, amount, pan, exp_date, crypt_type, cust_id

//Sample Request:

purchase,order_1_testing,13.00,4242424242424242,0304,1

purchase_supp,order_2_testing,2.00,4242424242424242,0908,1,customer_1

Response Format:

ReceiptId, ReferenceNum, ResponseCode, ISO, AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket

Sample Response:

order_1_testing,660021810013368320,027,01,010460,11:04:27,2006-06-20,00,true,APPROVED * =,13.00,V,63790-832-0,false,,null

order_2_testing,660021810013368330,027,01,009494,11:04:28,2006-06-20,00,true,APPROVED * =,2.00,V,63791-833-0,false,,null

                
USA Code Sample

//Request Format:

us_purchase, order_id, cust_id, amount, pan, expdate, crypt_type, commcard_invoice, commcard_tax_amount

//Sample Request:

us_purchase,Order_1_regular,Cust_1,5.10,4242424242424242,0911,1,invoice 1,0.15

//Response Format:

ReceiptId, ReferenceNum, ResponseCode, [reserved], AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, RecurSuccess, AvsResultCode

Sample Response:

Order_1_regular,640000010010484780,001,,693151,17:21:25,2006-08-23,00,true,APPROVED 693151,5.10,V,7- 0_0,false,,null,,
                

Purchase mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID.

For Refund, Completion and Purchase Correction transactions, the order ID must be the same as that of the original transaction.

Canada: The last 10 characters of the order ID are displayed in the “Invoice Number” field on the Merchant Direct Reports. However only letters, numbers and spaces are sent to Merchant Direct.

A minimum of 3 and a maximum of 10 valid characters are sent to Merchant Direct. Only the last characters beginning after any invalid characters are sent. For example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, If the order ID has fewer than 3 characters, it may display a blank or 0000000000 in the Invoice Number field.
Amount String 9-character decimal amount Transaction amount This must contain at least 3 digits, two of which are penny values.
The minimum allowable value is $0.01, and the maximum allowable value is $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric 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 numeric
YYMM format.
expdate Submit in YYMM format.
Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character alphanumeric crypt_type Supported values are:
  • 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

Purchase optional values

Value Type Limits Variable Decription
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.
Commercial card invoice String 17-character alphanumeric commcard_invoice Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal commcard_tax_amount Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
AVS Information Object avs_info Refer below for further breakdown and definition.
Recurring Billing Object recur Refer below for further breakdown and definition.

Predecessors
  • None
Successors

Purchase with AVS

Address Verification Service (AVS) is an optional fraud-prevention tool offered by issuing banks whereby a cardholder's address is submitted as part of the transaction authorization. The AVS address is then compared to the address kept on file at the issuing bank. AVS checks whether the street number, street name and zip/postal code match. The issuing bank returns an AVS result code indicating whether the data was matched successfully. Regardless of the AVS result code returned, the credit card is authorized or declined by the issuing bank.

The response that is received from AVS verification is intended to provide added security and fraud prevention, but the response itself does not affect the completion of a transaction. Upon receiving a response, the choice to proceed with a transaction is left entirely to the merchant. The responses is not a strict guideline of whether a transaction will be approved or declined.

Things to consider:

  • AVS is only supported by Visa, MasterCard, Discover and American Express.
  • When testing AVS, you must only use the Visa test card numbers 4242424242424242 or 4005554444444403, and the amounts described in the Simulator eFraud Response Codes Table
  • For a full list of possible AVS result codes refer to the AVS Result Code table

USA Code Sample

//Request Format:

us_purchase:avs_info, order_id, cust_id, amount, pan, exp_date, crypt_type, commcard_invoice, commcard_tax_amount, avs_street_number, avs_street_name, avs_zipcode 

//Sample Request:

us_purchase:avs_info,Order_1_avs,Cust_1,10.30,4242424242424242,0812,1,invoice 99,0.75,999,Michigan Ave,M1M1M1 us_purchase:avs_info,Order_2_avs,,10.30,4242424242424242,0812,1,,,999,Michigan Ave,M1M1M1

Response Format:

ReceiptId, ReferenceNum, ResponseCode, [reserved], AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, RecurSuccess, AvsResultCode

Sample Response:

Order_1_avs,640000010010500330,001,,346679,13:07:42,2006-08-24,00,true,APPROVED 346679,10.30,V,43- 0_1,false,,null,,B Order_2_avs,640000010010500340,001,,227820,13:07:45,2006-08-24,00,true,APPROVED 227820,10.30,V,44- 0_1,false,,null,,B
                

Purchase mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID.

For Refund, Completion and Purchase Correction transactions, the order ID must be the same as that of the original transaction.

Canada: The last 10 characters of the order ID are displayed in the “Invoice Number” field on the Merchant Direct Reports. However only letters, numbers and spaces are sent to Merchant Direct.

A minimum of 3 and a maximum of 10 valid characters are sent to Merchant Direct. Only the last characters beginning after any invalid characters are sent. For example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, If the order ID has fewer than 3 characters, it may display a blank or 0000000000 in the Invoice Number field.
Amount String 9-character decimal amount Transaction amount This must contain at least 3 digits, two of which are penny values.
The minimum allowable value is $0.01, and the maximum allowable value is $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric 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 numeric
YYMM format.
expdate Submit in YYMM format.
Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character alphanumeric crypt_type Supported values are:
  • 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

Purchase optional values

Value Type Limits Variable Decription
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.
Commercial card invoice String 17-character alphanumeric commcard_invoice Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal commcard_tax_amount Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
AVS Information Object avs_info Refer below for further breakdown and definition.
Recurring Billing Object recur 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

AVS Response Fields

Value Limits Variable Description
AVS result code 1-character alphanumeric AvsResultCode Indicates the address verification result. For a full list of possible response codes refer to the AVS Result Code table.

Predecessors
  • None
Successors

Purchase with Recurring Billing

Verifies funds on the customer’s card, removes the funds and prepares them for deposit into the merchant’s account.

Recurring Billing allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cycle information you provide.

Things to consider:

  • To avoid shifting, do not set the start_date after the 28th if the recur_unit is month. To set the billing date for the last day of the month, set recur_unit to eom.

Canada Code Sample

//Request Format:

purchase, order_id, amount, pan, exp_date, crypt_type, recur_unit, start_now, start_date, num_recurs, period, recur_amount

//Sample Request:

purchase,order_1_recurring,3.00,4242424242424242,0712,2,week,true,2006/10/30,4,2,1.00 purchase,order_2_recurring,4.00,4242424242424242,0803,2,day,false,2006/10/15,30,10,4.00 purchase,order_3_recurring,5.00,4242424242424242,0610,2,month,true,2006/11/11,12,1,1.00

//Response Format:

ReceiptId, ReferenceNum, ResponseCode, ISO, AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, RecurSuccess

//Sample Response:

order_1_recurring,660021810013368380,027,01,008598,11:28:28,2006-06-20,00,true,APPROVED * =: Recurring transaction successfully registered.,3.00,V,63796-838-0,false,,null,true 

order_2_recurring,null,null,null,null,null,null,null,true,Recurring transaction successfully registered.,null,null,null,false,,null,true 

order_3_recurring,660021810013368390,027,01,010535,11:28:34,2006-06-20,00,true,APPROVED * =: Recurring transaction successfully registered.,5.00,V,63797-839-0,false,,null,true
                
USA Code Sample

//Request Format:

us_purchase:recur, order_id, cust_id, amount, pan, expdate, crypt_type, commcard_invoice, commcard_tax_amount, recur_unit, start_now, start_date, num_recurs, period, recur_amount 

//Sample Request:

us_purchase:recur,Order_1_recurring,Cust_1,3.00,4242424242424242,0712,2,invoice 1,0.15,week,true,2007/10/30,4,2,1.00 

us_purchase:recur,Order_2_recurring,Cust_2,4.00,4242424242424242,0803,2,,,day,false,2007/10/15,30,10,4.00 

us_purchase:recur,Order_3_recurring,,5.00,4242424242424242,0610,2,,,month,true,2007/11/11,12,1,1.00 

//Response Format:

ReceiptId, ReferenceNum, ResponseCode, [reserved], AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, RecurSuccess, AvsResultCode

//Sample Response:

Order_1_recurring,640000010010500310,001,,172979,12:50:42,2006-08-24,00,true,APPROVED 172979: Recurring transaction successfully registered.,3.00,V,41-0_1,false,,null,true, 

Order_2_recurring,null,null,null,null,null,null,null,true,Recurring transaction successfully registered.,null,null,null,false,,null,true, 

Order_3_recurring,640000010010500320,001,,538478,12:50:48,2006-08-24,00,true,APPROVED 538478: Recurring transaction successfully registered.,5.00,V,42-0_1,false,,null,true,
                

Purchase mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID.

For Refund, Completion and Purchase Correction transactions, the order ID must be the same as that of the original transaction.

Canada: The last 10 characters of the order ID are displayed in the “Invoice Number” field on the Merchant Direct Reports. However only letters, numbers and spaces are sent to Merchant Direct.

A minimum of 3 and a maximum of 10 valid characters are sent to Merchant Direct. Only the last characters beginning after any invalid characters are sent. For example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, If the order ID has fewer than 3 characters, it may display a blank or 0000000000 in the Invoice Number field.
Amount String 9-character decimal amount Transaction amount This must contain at least 3 digits, two of which are penny values.
The minimum allowable value is $0.01, and the maximum allowable value is $999999.99. Transaction amounts of $0.00 are not allowed.
Credit card number String 20-character numeric 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 numeric
YYMM format.
expdate Submit in YYMM format.
Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character alphanumeric crypt_type Supported values are:
  • 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

Purchase optional values

Value Type Limits Variable Decription
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.
Commercial card invoice String 17-character alphanumeric commcard_invoice Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal commcard_tax_amount Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
AVS Information Object avs_info Refer below for further breakdown and definition.
Recurring Billing Object recur Refer below for further breakdown and definition.

Recurring mandatory values
Value Type Limits Argument name in example Description
Recur unit String day, week, month or eom recur_unit Unit to be used as a basis for the interval. This can be set as day, week, month or the end of the month.
Works in conjunction with the period argument (see below) to define the billing frequency.
Start Now String true/false start_now If a single charge is to be made against the card immediately, set this value to true. The amount to be billed immediately may differ from the amount billed on a regular basis thereafter.
If the billing is to start in the future, set this value to false.
Start Date String YYYY/MM/DD format start_date Date of the first future recurring billing transaction. This value must be a date in the future.
If an additional charge is to be made immediately, the start_now argument must be set to true.
Number of Recurs String numeric 1-99 num_recurs The number of times that the transaction must recur.
Period String numeric 1-999 period Number of recur units that must pass between recurring billings.
Recurring Amount String 9-character decimal 0.01-9999999.99. recur_amount Amount of the recurring transaction. This must contain at least three digits, two of which are penny values.
This is the amount that will be billed on the start_date, and then billed repeatedlybased on the interval defined by period and recur_unit.

Recurring Billing Response Fields

Value Limits Variable Description
Recurring billing success true/false RecurSuccess Indicates whether the recurring billing transaction has been successfully set up for future billing.

Predecessors
  • None
Successors

Purchase with Vault

This transaction uses the data key to identify a previously registered credit card profile. The details saved within the profile are then submitted to perform a Purchase transaction.

The Vault feature allows merchants to create long term customer profiles, edit those profiles, and use them to process transactions without having to enter financial information each time.

Canada Code Sample

//Request Format:

res_purchase_cc,order_id,cust_id,amount,data_key,crypt_type

//Sample Request:

res_purchase_cc,mjr-res-purch-210510-251-1,moneris,1.00,M6eGTseSjlDBxYRICD3rgAhBn,1

//Response Format:

ReceiptId, ReferenceNum, ResponseCode, ISO, AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, reserved, reserved, reserved, reserved

//Sample Response:

mjr-res-purch-210510-251-1,660035500012243850,027,01,073570,14:52:55,2010-05-21,00,true,APPROVED * =,1.00,M,112072-0_7,false,,,M6eGTseSjlDBxYRICD3rgAhBn,cc,,,bob@smith.com,this is my note,5454***5454,0812,1,,,,
                
USA Code Sample

//Request Format:

us_res_purchase_cc, order_id, cust_id, amount, data_key, crypt_type, commcard_invoice, commcard_tax_amount

//Sample Request:

us_res_purchase_cc,Pat-mjr-res-purch-100210-1230-1,Moneris,1.00,rILL5410i6914o62TMg3s32,1,invoice,0.15

//Response Format:

ReceiptId, ReferenceNum, ResponseCode, [reserved], AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, RecurSuccess, AvsResultCode, 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:

Pat-mjr-res-purch-100210-1230-1,640000030016576400,001,,025084,10:32:18,2010-02-23,00,true,APPROVED 025084,1.00,M,784357-0_10,false,,,null,X,rILL5410i6914o62TMg3s32,cc,customer1,0000000000,bob@smith.com,my note,5454***5454,0909,7,212,Payton Street,M1M1M1,,,,,,,,,,,,,,
                

Purchase with Vault mandatory values

VALUE TYPE LIMITS VARIABLE DESCRIPTION
Data Key String 25-character alphanumeric data_key The data key is the token that points to a previously stored profile. 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.
Order ID String 50-character alphanumeric order_id Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID.

For Refund, Completion and Purchase Correction transactions, the order ID must be the same as that of the original transaction.

Canada: The last 10 characters of the order ID are displayed in the “Invoice Number” field on the Merchant Direct Reports. However only letters, numbers and spaces are sent to Merchant Direct.

A minimum of 3 and a maximum of 10 valid characters are sent to Merchant Direct. Only the last characters beginning after any invalid characters are sent. For example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, If the order ID has fewer than 3 characters, it may display a blank or 0000000000 in the Invoice Number field.
Amount String 9-character decimal amount Transaction amount This must contain at least 3 digits, two of which are penny values.
The minimum allowable value is $0.01, and the maximum allowable value is $999999.99. Transaction amounts of $0.00 are not allowed.
E-Commerce indicator String 1-character alphanumeric crypt_type Supported values are:
  • 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

Purchase with Vault optional values

VALUE TYPE LIMITS VARIABLE DECRIPTION
Expiry Date String 4-character numeric
YYMM format.
expdate The optional Expiry Date applies to Hosted Tokenization transactions. If the expiry date was not collected by Hosted Tokenization solution, then it must be set in the Vault transaction request.
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.
Commercial card invoice String 17-character alphanumeric commcard_invoice Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal commcard_tax_amount Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
AVS Information Object avs_info Refer below for further breakdown and definition.
Recurring Billing Object recur Refer below for further breakdown and definition.

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
  • Vault Tokenize Credit Card (API)
  • Vault Add Credit Card (Hosted Vault | API | Batch)
  • Vault Encrypted Add Credit Card (API)
  • Vault Add Token (API)
Successors

Purchase with Vault and AVS

This transaction uses the data key to identify a previously registered credit card profile. The details saved within the profile are then submitted to perform a Purchase transaction.

Address Verification Service (AVS) is an optional fraud-prevention tool offered by issuing banks whereby a cardholder's address is submitted as part of the transaction authorization. The AVS address is then compared to the address kept on file at the issuing bank. AVS checks whether the street number, street name and zip/postal code match. The issuing bank returns an AVS result code indicating whether the data was matched successfully. Regardless of the AVS result code returned, the credit card is authorized or declined by the issuing bank.

The response that is received from AVS verification is intended to provide added security and fraud prevention, but the response itself does not affect the completion of a transaction. Upon receiving a response, the choice to proceed with a transaction is left entirely to the merchant. The responses is not a strict guideline of whether a transaction will be approved or declined.

Things to consider:

  • AVS is only supported by Visa, MasterCard, Discover and American Express.
  • When testing AVS, you must only use the Visa test card numbers 4242424242424242 or 4005554444444403, and the amounts described in the Simulator eFraud Response Codes Table.
  • For a full list of possible AVS result codes refer to the AVS Result Code table.

USA Code Sample

//Request Format:

us_res_purchase_cc:avs_info,order_id,cust_id,amount,data_key,crypt_type,commcard_invoice, commcard_tax_amount, avs_street_number, avs_street_name, avs_zipcode

//Sample Request:

us_res_purchase_cc:avs_info,Order_4_avs,,10.30,RUYlBO3UXXrpGBzJoILIZPgGd,1,invoice,0.15,101,Main Street,123456

//Response Format:

ReceiptId, ReferenceNum, ResponseCode, [reserved], AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, RecurSuccess, AvsResultCode, 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_4_avs,640000010011411020,001,,692460,12:34:08,2010-02-10,00,true,APPROVED 692460,10.30,V,58132- 0_10,false,,,null,B,RUYlBO3UXXrpGBzJoILIZPgGd,cc,marta,phone,email,note,4242***4242,1010,7,999,Michigan Ave,M1M1M1,,,,,,,,,,,,,,

                

Purchase with Vault mandatory values

VALUE TYPE LIMITS Variable DESCRIPTION
Data Key String 25-character alphanumeric data_key The data key is the token that points to a previously stored profile. 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.
Order ID String 50-character alphanumeric order_id Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID.

For Refund, Completion and Purchase Correction transactions, the order ID must be the same as that of the original transaction.

Canada: The last 10 characters of the order ID are displayed in the “Invoice Number” field on the Merchant Direct Reports. However only letters, numbers and spaces are sent to Merchant Direct.

A minimum of 3 and a maximum of 10 valid characters are sent to Merchant Direct. Only the last characters beginning after any invalid characters are sent. For example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct.

US: The last 32 characters of the order ID are sent on to the Client Line settlement reports.

For either countries, If the order ID has fewer than 3 characters, it may display a blank or 0000000000 in the Invoice Number field.
Amount String 9-character decimal amount Transaction amount This must contain at least 3 digits, two of which are penny values.
The minimum allowable value is $0.01, and the maximum allowable value is $999999.99. Transaction amounts of $0.00 are not allowed.
E-Commerce indicator String 1-character alphanumeric crypt_type Supported values are:
  • 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

Purchase with Vault optional values

VALUE TYPE LIMITS Variable DECRIPTION
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number.
This field is searchable from the Moneris Merchant Resource Centre.
Commercial card invoice String 17-character alphanumeric commcard_invoice Available to US integrations only. Level 2 Invoice Number for the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). Characters allowed for commcard_invoice: a-z A-Z 0-9 spaces
Commercial card tax amount String 9-character decimal commcard_tax_amount Available to US integrations only. Level 2 Tax Amount of the transaction used for Corporate Credit Card transactions (Commercial Purchasing Cards). This must contain 3 digits with two penny values. The minimum value passed can be 0.00 and the maximum is 9999999.99
AVS Information Object avs_info Refer below for further breakdown and definition.
Recurring Billing Object recur Refer below for further breakdown and definition.

AvsInfo object 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

AVS Response Fields

Value Limits Variable Description
AVS result code 1-character alphanumeric AvsResultCode Indicates the address verification result. For a full list of possible response codes refer to the AVS Result Code table.

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
  • Vault Tokenize Credit Card (API)
  • Vault Add Credit Card (Hosted Vault | API | Batch)
  • Vault Encrypted Add Credit Card (API)
  • Vault Add Token (API)
Successors

Purchase with Vault and ACH

This transaction uses the data key to identify a previously registered ACH profile. The details saved within the profile are then submitted to perform the transaction.

This transaction is processed as an ACH Debit. The ACH Info registered for this profile will be used. The details submitted within ACHInfo object are returned in the response.

ACH transactions are available to US integrations only.

USA Code Sample

//Request Format:

us_res_purchase_ach, order_id, cust_id, amount, data_key

Sample Request:

us_res_purchase_ach,PAT-mjr-res-ach-purch-100210-1230-1,Moneris,1.00,COfxgha5Wb4lRG7sxpCKWQpRe

//Response Format:

ReceiptId, ReferenceNum, ResponseCode, [reserved], AuthCode, TransTime, TransDate, TransType, Complete, Message, TransAmount, CardType, TxnNumber, TimedOut, BankTotals, Ticket, RecurSuccess, AvsResultCode, 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:

PAT-mjr-res-ach-purch-100210-1230-1,000783750010690710,005,,,10:32:36,2010-02-23,00,true,REGISTERED * =,1.0,CQ,1130- 0_10,false,,,true,null,COfxgha5Wb4lRG7sxpCKWQpRe,ach,,,,,,,,,,,,,ppd,,,,,,,,123456789,8574***9829,123,chec king
                
Mandatory Values
Value Type Limits Variable Description
Data key String 25-character decimal data_key The data key is the token that points to a previously stored profile. Profile identifier that all future financial Vault transactions 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.
Order ID String 50-character alphanumeric order_id Merchant-defined transaction identifier that must be unique for every ACH debit and credit transaction. No two transactions of these types may have the same order ID. For ACH reversal transactions, the order ID must be the same as that of the original transaction.
Amount String 9-character decimal amount Transaction amount This must contain at least 3 digits, two of which are penny values.

The minimum allowable value is $0.01, and the maximum allowable value is $999999.99. Transaction amounts of $0.00 are not allowed.
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. This field is searchable from the Moneris Merchant Resource Centre.
Recurring billing Object Not applicable. recur

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.
Payment Type 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 alphanumeric 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 alphanumeric 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 numeric cust_zip Returns the customer zip code saved in the profile.
Check Routing Number 9-character numeric 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 numeric 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
Successors