My Profile_

Pre-Authorization

Verifies and locks funds on the customer’s credit card. The funds are locked for a specified amount of time based on the card issuer.

To retrieve the funds that have been locked by a Pre-Authorization transaction so that they may be settled in the merchant’s account, a Completion transaction must be performed.

Things to consider:

  • If a Pre-Authorization transaction is not followed by a Completion transaction, it must be reversed via a Completion transaction for 0.00.
  • A Pre-Authorization transaction may only be "completed" once. If the Completion transaction is for less than the original amount, a Re-Authorization transaction is required to collect the remaining funds by another Completion transaction.

Canada Code Sample

//Request Format:

preauth, order_id, amount, pan, exp_date, crypt_type 

preauth_supp, order_id, amount, pan, exp_date, crypt_type, cust_id

//Sample Request:

preauth,order_4_testing,14.00,4242424242424242,0503,1

preauth_supp,order_9_testing,14.00,4242424242424242,0503,1,customer

//Response Format:

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

//Sample Response:

order_4_testing,660021810013368350,027,01,010462,11:04:31,2006-06-20,01,true,APPROVED * =,14.00,V,63793-835-0,false,,null

order_9_testing,660021810013368360,027,01,011232,11:04:31,2006-06-20,01,true,APPROVED * =,14.00,V,63793-836-0,false,,null
USA Code Sample

//Request Format:

us_preauth, order_id, cust_id, amount, pan, expdate, crypt_type

//Sample Request:

us_preauth,Order_2_regular,Cust_2,2.00,4242424242424242,0812,1

//Response Format:

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

//Sample Response:

Order_2_regular,640000010010484790,001,,475122,17:21:27,2006-08-23,01,true,APPROVED 475122,2.00,V,8- 0_0,false,,null,,

Pre-Authorization 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 10-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 $9999999.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

Pre-Authorization optional values

Value Type Limits Variable Decription
AVS Object avs_info Refer below for further breakdown and definition.
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.

Predecessors
  • NA
Successors
  • Pre-Authorization Completion ( API | Batch File)
  • Vault Tokenize Credit Card ( API )

Pre-Authorization 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 tables.

USA Code Sample

//Request Format:

us_preauth:avs_info, order_id, cust_id, amount, pan, exp_date, crypt_type, avs_street_number, avs_street_name, avs_zipcode

//Sample Request:

us_preauth:avs_info,Order_3_avs,Cust_1,10.30,4242424242424242,0909,1,101,Main Street,123456

//Response Format:

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

//Sample Response:

Order_3_avs,640000010010500350,001,,852893,13:07:47,2006-08-24,01,true,APPROVED 852893,10.30,V,45- 0_1,false,,null,,B

Pre-Authorization 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 10-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 $9999999.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

Pre-Authorization optional values

Value Type Limits Variable Decription
AVS Object avs_info Refer below for further breakdown and definition.
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.
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
  • NA
Successors
  • Pre-Authorization Completion ( API | Batch File)
  • Vault Tokenize Credit Card ( API )

Pre-Authorization 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_preauth_cc, order_id, cust_id, amount, data_key, crypt_type

//Sample Request:

res_preauth_cc,mjr-res-preauth-210510-251-1,moneris,1.00,Ef3QO7bzCE3hTzmDqjvC5dMdl,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-preauth-210510-251-1,660035500012243860,027,01,073571,14:53:01,2010-05-21,01,true,APPROVED * =,1.00,M,112073-0_7,false,,,Ef3QO7bzCE3hTzmDqjvC5dMdl,cc,,,bob@smith.com,this is my note,5454***5454,0812,1,,,,
USA Code Sample

//Request Format:

us_res_preauth_cc, order_id, cust_id, amount, data_key, crypt_type

//Sample Request:

us_res_preauth_cc,PAT-mjr-res-preauth-100210-1230-1,Moneris,1.00,rILL5410i6914o62TMg3s32,1

//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-preauth-100210-1230-1,640000030016576410,001,,025085,10:32:31,2010-02-23,01,true,APPROVED 025085,1.00,M,784358-0_10,false,,,null,X,rILL5410i6914o62TMg3s32,cc,customer1,0000000000,bob@smith.com,my note,5454***5454,0909,7,212,Payton Street,M1M1M1,,,,,,,,,,,,,,

Pre-Authorization 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 10-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 $9999999.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

Pre-Authorization 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.
AVS Information Object avs_info 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 ( API )
Successors

Pre-Authorization 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 Pre-Authorization 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_preauth_cc:avs_info,order_id,cust_id,amount,data_key, crypt_type,avs_street_number,avs_street_name,avs_zipcode

//Sample Request:

us_res_preauth_cc:avs_info,Order_5_avs,Cust,10.30,RUYlBO3UXXrpGBzJoILIZPgGd,1,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_5_avs,640000010011411060,001,,279691,12:34:14,2010-02-10,01,true,APPROVED 279691,10.30,V,58136- 0_10,false,,,null,B,RUYlBO3UXXrpGBzJoILIZPgGd,cc,marta,phone,email,note,4242***4242,1010,7,999,Michigan Ave,M1M1M1,,,,,,,,,,,,,,

Pre-Authorization 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 10-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 $9999999.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

Pre-Authorization 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.
AVS Information Object avs_info 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.

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 ( API )
Successors