In banking a debit transaction is when you take funds from an account. (This is the same function as a sale transaction on a credit card). An ACH debit transaction authorizes to "pull" funds from a customer bank account, typically used for a sale or subscription.

Parameters

The following parameters are available to process an ACH Debit transaction.

parameter	description	required
mid	the Merchant ID (MID) assigned by QorCommerce or your merchant service provider (MSP)	Yes
reference_id	A reference id that will be echo'd back in the message response.	No
amount	the total amount to debit	Yes
orderid	a unique merchant order tracking number	Yes
checknumber	check number to capture	No
checkdate	date provided for the check	No
transactiondate	date to assign for the transaction	No
name_on_account	name of the account holder (specifically used for corporate accounts)	No
routing_number	bank routing number for debit	Yes
account_number	bank account number to debit	Yes
account_type	bank account type. valid options are `1 = personal checking` `2 = personal savings` `3 = corporate checking` `4 = corporate savings`	Yes
account_nickname	nickname for the account	Yes
bankname	name of the bank for debit	No
bankcity	bank city	No
bankstate	bank 2-char state code	No
customerid	debited account holder customer ID	No
cfirstname	debited account holder first name	No
clastname	debited account holder last name	No
cphone	debited account holder phone numbern	No
cemail	debited account holder email	No
caddress1	debited account holder street 1 address	No
caddress2	debited account holder street address	No
ccity	debited account holder city	No
cstate	debited account holder state	No
czip	debited account holder zip code	No
memo	free form text	No
store_accnt	whether or not to store the account info for future use and return a token	No
metadata	a set of key-value pairs that you can attach to a payment. This can be useful for storing additional information about the payment in a structured format.	No

JSON Example

The following JSON example provides a template for all the ACH Debit parameter values. You can copy and paste these values in the Body Params section above to be used by the Try It feature

* is for required values

{
  "transaction_data": {
    "mid": "",
    "amount": "",
    "orderid": "",
    "seccode": "",
    "checknumber": "* if seccode = RCK",
    "checkdate": "",
    "transactiondate": "",
    "name_on_account": "",
    "routing_number": "",
    "account_number": "",
    "account_type": "",
    "account_nickname": "",
    "bankname": "",
    "bankcity": "",
    "bankstate": "",
    "customerid": "",
    "cfirstname": "",
    "clastname": "",
    "cphone": "",
    "cemail": "",
    "caddress1": "",
    "caddress2": "",
    "ccity": "",
    "cstate": "",
    "czip": "",
    "memo": "",
    "store_accnt": ""
  }
}

Store Account Option

You can store the debited bank account information provided in the QorCommerce Secure Vault by setting the store_ach parameter to true. The response will provide an ach_token value representing the customers bank information that you can associate with the customer and/or a contract to use for future payments.

References

Links to related pages.