My Profile_


ACH Debit

Verifies and collects the customer’s bank account information, removes the funds directly from the bank account and prepares them for deposit into the merchant’s account.

The ACH Debit transaction has ACH Info object as a mandatory property.

Things to consider:

  • All alphanumeric ACH Info fields allow the following characters: a-z A-Z 0-9 _ - : . @ $ = /
  • If you send characters that are not included in the allowed list, the ACH transaction may not be properly registered.
  • ACH Info fields are not used for any type of address verification or fraud check.

ACH transactions are available to US integrations only.

USA Code Sample

//Request Format:

us_ach_debit:ach_info, order_id, cust_id, amount, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_zip, routing_num, account_num, check_num, account_type, [reserved]

//Sample Request:

us_ach_debit:ach_info,Order_1_ACH,cust_id,1.00,ppd,Bob,Smith,101 Main St,#2,Chicago,IL,123456,123456789,12345,101,savings

//Response Format:

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

//Sample Response:

Order_1_ACH,000000090010070010,005,01,,15:40:26,2007-06-22,00,true,REGISTERED * =,1.0,CQ,73-0_5,false,,null,true,


                

ACH Debit Transaction 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 ACH debit and credit transaction. No two transactions of these types may have the same order ID.
For transactions, the order ID must be the same as that of the original transaction.
Amount String 9-character decimal amount Transaction amount. Used in a number of transactions. Note that this is different from the amount used in a Completion transaction, which is an alphanumeric value.
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 999 999.99. Transaction amounts of $0.00 are not allowed.
ACH Info Object ach_info Refer below for further breakdown and definition.

ACH Debit 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, invoiceand invoice number and so on.
This field is searchable from the Moneris Merchant Resource Centre.
Recurring billing Object recur Refer below for further breakdown and definition.

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 zip code.
Check Number String 16-character numeric 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.

Predecessors
  • NA
Successors

ACH Debit with Recurring Billing

ACH Debit with Recurring Billing

Verifies and collects the customer’s bank account information, removes the funds directly from the bank account 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.

Any transaction that supports Recurring Billing has a recur component. This is used to write the Recurring Billing information to the transaction object before writing the transaction.

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.

ACH transactions are available to US integrations only.

USA Code Sample

//Request Format:

us_ach_debit:ach_info:recur, order_id, cust_id, amount, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_zip, routing_num, account_num, check_num, account_type, [reserved], recur_unit, start_now, start_date, num_recurs, period, recur_amount

us_ach_debit:recur:ach_info, order_id, cust_id, amount, recur_unit, start_now, start_date, num_recurs, period, recur_amount, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_zip, routing_num, account_num, check_num, account_type, [reserved]

//Sample Request:

us_ach_debit:ach_info:recur,Order_4_ACH_recur,cust_id,1.00,ppd,Bob,Smith,101 Main St,#2,Chicago,IL,123456,123456789,12345,101,savings,,month,false,2007/11/11,12,1,1.00 

us_ach_debit:recur:ach_info,Order_5_ACH_recur,,1.00,month,true,2007/11/11,12,1,1.00,ppd,Bob,Smith,101 Main St,#2,Chicago,IL,123456,123456789,12345,101,savings,

//Response Format:

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

//Sample Response:

Order_4_ACH_recur,null,005,null,null,null,null,null,true,Recurring transaction successfully registered.,null,null,null,false,,null,true, 

Order_5_ACH_recur,000000090010070110,005,01,,14:21:15,2007-06-25,00,true,REGISTERED * =: Recurring transaction successfully registered.,1.0,CQ,83-0_5,false,,null,true,


                

ACH Debit transaction mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric order_id Merchant-defined transaction identifier that must be unique for every Purchase, PreAuth and Independent Refund 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. Used in a number of transactions. Note that this is different from the amount used in a Completion transaction, which is an alphanumeric value.

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 999 999.99. Transaction amounts of $0.00 are not allowed.
ACH Info String Not applicable. ach_info

ACH Debit transaction 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.
Recurring billing Object Not applicable. recur Refer below for further breakdown and definition.

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.

Recurring object mandatory values
Value Type Limits Variable 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 IIf 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
  • NA
Successors

ACH Debit with Vault

Refer to 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 also referred to as Purchase with Vault and ACH.

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


                

ACH Debit 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 will use to associate with the saved information.

The data key is generated by Moneris, and is returned to the merchant 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.

ACH Debit with Vault 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.
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
Successors

ACH Credit

Verifies and collects the customer’s bank account information, and transfers merchant funds directly to the customer.

ACH transactions are available to US integrations only.

USA Code Sample

//Request Format:

us_ach_credit:ach_info, order_id, cust_id, amount, sec, cust_first_name, cust_last_name, cust_address1, cust_address2, cust_city, cust_zip, routing_num, account_num, check_num, account_type, [reserved]

//Sample Request:

us_ach_credit:ach_info,Order_2_ACH,cust_id,1.00,ppd,Bob,Smith,101 Main St,#2,Chicago,IL,123456,123456789,12345,101,savings

//Response Format:

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

//Sample Response:

Order_2_ACH,000000090010070020,005,01,null,15:40:26,2007-06-22,04,true,REGISTERED * =,1.0,CQ,74-0_5,false,,null,false,


                

ACH Credit transaction 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 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. Used in a number of transactions. Note that this is different from the amount used in a Completion transaction, which is an alphanumeric value.

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 999 999.99. Transaction amounts of $0.00 are not allowed.
ACH Info Object Not applicable. ach_info Refer below for further breakdown and definition.

ACH Credit 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.

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.

Predecessors

  • NA

Successors

  • NA

ACH Credit with Vault

Refer to Independent Refund 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 Credit. The ACH Info registered for this profile will be used. The details submitted within ACH Info are returned in the response.

The transaction is also referred to as Independent Refund with Vault and ACH.

ACH transactions are available to US integrations only.

USA Code Sample

//Request Format:

us_res_ind_refund_ach, order_id, cust_id, amount, data_key

//Sample Request:

us_res_ind_refund_ach,PAT-mjr-res-ach-indref-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-indref-100210-1230-1,000783750010690720,005,,null,10:32:36,2010-02-23,04,true,REGISTERED * =,1.0,CQ,1131- 0_10,false,,,false,null,COfxgha5Wb4lRG7sxpCKWQpRe,ach,,,,,,,,,,,,,ppd,,,,,,,,123456789,8574***9829,123,checking


                

ACH Credit with vault mandatory values

Value Type Limits Variable Description
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 ACH transaction) will use to associate with the saved information.

The data key is generated by Moneris, and is returned to the merchant 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. Used in a number of transactions. Note that this is different from the amount used in a Completion transaction, which is an alphanumeric value.

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 999 999.99. Transaction amounts of $0.00 are not allowed.

ACH Credit 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.
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
Successors
  • NA

ACH Reversal

Refunds the full amount of an ACH Debit transaction.

This transaction can only be performed against an ACH Debit transaction that was performed within the last 3 months.

ACH transactions are available to US integrations only.

USA Code Sample

//Request Format:

us_ach_reversal, order_id, txn_number

//Sample Request:

us_ach_reversal,Order_3_ACH,81-0_5

//Response Format:

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

//Sample Response:

Order_3_ACH,000000090010070090,005,01,null,14:46:10,2007-06-25,11,true,REGISTERED * =,1.0,CQ,81-1_5,false,,null,false,


                

ACH Reversal transaction object mandatory values

Value Type Limits Set method Description
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.
Transaction number String 255-character variable txn_number Used when performing follow-on transactions. (That is, Completion, Purchase Correction, Refund or ACH Reversal) This must be the value that was returned as the transaction number in the response of the original transaction.

Predecessors
Successors
  • NA