Interface MerchantAch
Merchant ACH processing interface. Defines all methods that an ACH payment
gateway must implement. Note: not all methods are required to be supported.
Methods summary
public
array
|
#
processAch( array $account_info, float $amount, array $invoice_amounts = null )
Process an ACH transaction
Process an ACH transaction
Parameters
- $account_info
array
$account_info An array of bank account info including: - first_name The first
name on the account - last_name The last name on the account - account_number
The bank account number - routing_number The bank account routing number - type
The bank account type (checking or savings) - address1 The address 1 line of the
card holder - address2 The address 2 line of the card holder - city The city of
the card holder - state An array of state info including: - code The 2 or
3-character state code - name The local name of the country - country An array
of country info including: - alpha2 The 2-character country code - alpha3 The
3-character country code - name The english name of the country - alt_name The
local name of the country - zip The zip/postal code of the account holder- $amount
float
$amount The amount to debit this account- $invoice_amounts
array
$invoice_amounts An array of invoices, each containing: - id The ID of the
invoice being processed - amount The amount being processed for this invoice
(which is included in $amount) Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
public
array
|
#
voidAch( string $reference_id, string $transaction_id )
Void an ACH transaction
Parameters
- $reference_id
string
$reference_id The reference ID for the previously authorized transaction- $transaction_id
string
$transaction_id The transaction ID for the previously authorized transaction Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
public
array
|
#
refundAch( string $reference_id, string $transaction_id, float $amount )
Refund an ACH transaction
Refund an ACH transaction
Parameters
- $reference_id
string
$reference_id The reference ID for the previously authorized transaction- $transaction_id
string
$transaction_id The transaction ID for the previously authorized transaction- $amount
float
$amount The amount to refund this account Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
Magic methods summary