Credit (Payout)

Process an ACH Credit


A credit transaction is when you add funds to an account. ACH credit transactions are most often used for direct deposit payroll transactions, P2P payments, and refunds. (This is the same function as a refund on a credit card)

Parameters

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

parameterdescriptionrequired

mid

the Merchant ID (MID) assigned by QorCommerce or your merchant service provider (MSP)

Yes

amount

the total amount to debit

Yes

orderid

a unique merchant order tracking number

Yes

seccode

# docTextSection:oLXpbhkedPf9iLPzh

Yes

checknumber

check number to assign

No

checkdate

date provided for the check

No

transactiondate

date to assign for the credit

No

name_on_account

name of the account holder (specifically used for corporate accounts)

No

routing_number

bank routing number for credit

Yes

account_number

bank account number to credit

Yes

account_type

bank account type. valid options are
1 = personal checking
2 = personal savings
3 = corporate checking
3 = corporate savings

Yes

bankname

name of the bank for credit

No

bankcity

bank city

No

bankstate

bank 2-char state code

No

customerid

credited account holder customer ID

No

cfirstname

credited account holder first name

No

clastname

credited account holder last name

No

cphone

credited account holder phone numbern

No

cemail

credited account holder email

No

caddress1

credited account holder street 1 address

No

caddress2

credited account holder street address

No

ccity

credited account holder city

No

cstate

credited account holder state

No

czip

credited 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

account_nickname

nickname for the account

Yes

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

The following JSON example provides a template for all the ACH Credit 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": "",
    "bankname": "",
    "bankcity": "",
    "bankstate": "",
    "customerid": "",
    "firstname": "",
    "lastname": "",
    "middleinitial": "",
    "cphone": "",
    "cemail": "",
    "caddress1": "",
    "caddress2": "",
    "ccity": "",
    "cstate": "",
    "czip": "",
    "memo": "",
    "store_ach": 0,
    "account_nickname": "nickname"
  }
}

Store Account Option

You can store the 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 your customer and/or a contract to use for payment when needed.

References

Language
Click Try It! to start a request and see the response here!