commerce_authnet.admin.inc in Commerce Authorize.Net 7
Administrative forms for the Authorize.Net module.
File
includes/commerce_authnet.admin.incView source
<?php
/**
* @file
* Administrative forms for the Authorize.Net module.
*/
/**
* Form callback: allows the user to capture a prior authorization.
*/
function commerce_authnet_aim_capture_form($form, &$form_state, $order, $transaction) {
$form_state['order'] = $order;
$form_state['transaction'] = $transaction;
// Load and store the payment method instance for this transaction.
$payment_method = commerce_payment_method_instance_load($transaction->instance_id);
$form_state['payment_method'] = $payment_method;
$balance = commerce_payment_order_balance($order);
if ($balance['amount'] > 0 && $balance['amount'] < $transaction->amount) {
$default_amount = $balance['amount'];
}
else {
$default_amount = $transaction->amount;
}
// Convert the price amount to a user friendly decimal value.
$default_amount = number_format(commerce_currency_amount_to_decimal($default_amount, $transaction->currency_code), 2, '.', '');
$description = implode('<br />', array(
t('Authorization: @amount', array(
'@amount' => commerce_currency_format($transaction->amount, $transaction->currency_code),
)),
t('Order balance: @balance', array(
'@balance' => commerce_currency_format($balance['amount'], $balance['currency_code']),
)),
));
$form['amount'] = array(
'#type' => 'textfield',
'#title' => t('Capture amount'),
'#description' => $description,
'#default_value' => $default_amount,
'#field_suffix' => check_plain($transaction->currency_code),
'#size' => 16,
);
$form = confirm_form($form, t('What amount do you want to capture?'), 'admin/commerce/orders/' . $order->order_id . '/payment', '', t('Capture'), t('Cancel'), 'confirm');
return $form;
}
/**
* Validate handler: ensure a valid amount is given.
*/
function commerce_authnet_aim_capture_form_validate($form, &$form_state) {
$transaction = $form_state['transaction'];
$amount = $form_state['values']['amount'];
// Ensure a positive numeric amount has been entered for capture.
if (!is_numeric($amount) || $amount <= 0) {
form_set_error('amount', t('You must specify a positive numeric amount to capture.'));
}
// Ensure the amount is less than or equal to the authorization amount.
if ($amount > commerce_currency_amount_to_decimal($transaction->amount, $transaction->currency_code)) {
form_set_error('amount', t('You cannot capture more than you authorized through Authorize.Net.'));
}
// If the authorization has expired, display an error message and redirect.
if (time() - $transaction->created > 86400 * 30) {
drupal_set_message(t('This authorization has passed its 30 day limit cannot be captured.'), 'error');
drupal_goto('admin/commerce/orders/' . $form_state['order']->order_id . '/payment');
}
}
/**
* Submit handler: process a prior authorization capture via AIM.
*/
function commerce_authnet_aim_capture_form_submit($form, &$form_state) {
$transaction = $form_state['transaction'];
$amount = number_format($form_state['values']['amount'], 2, '.', '');
// Build a name-value pair array for this transaction.
$nvp = array(
'x_type' => 'PRIOR_AUTH_CAPTURE',
'x_trans_id' => $transaction->remote_id,
'x_amount' => $amount,
);
// Submit the request to Authorize.Net.
$response = commerce_authnet_aim_request($form_state['payment_method'], $nvp);
// Update and save the transaction based on the response.
$transaction->payload[REQUEST_TIME] = $response;
// If we didn't get an approval response code...
if ($response[0] != '1') {
// Display an error message but leave the transaction pending.
drupal_set_message(t('Prior authorization capture failed, so the transaction will remain in a pending status.'), 'error');
drupal_set_message(check_plain($response[3]), 'error');
}
else {
drupal_set_message(t('Prior authorization captured successfully.'));
// Update the transaction amount to the actual capture amount.
$transaction->amount = commerce_currency_decimal_to_amount($amount, $transaction->currency_code);
// Set the remote and local status accordingly.
$transaction->status = COMMERCE_PAYMENT_STATUS_SUCCESS;
$transaction->remote_status = $response[11];
// Append a capture indication to the result message.
$transaction->message .= '<br />' . t('Captured: @date', array(
'@date' => format_date(REQUEST_TIME, 'short'),
));
}
commerce_payment_transaction_save($transaction);
$form_state['redirect'] = 'admin/commerce/orders/' . $form_state['order']->order_id . '/payment';
}
/**
* Form callback: allows the user to void a transaction.
*/
function commerce_authnet_aim_void_form($form, &$form_state, $order, $transaction) {
$form_state['order'] = $order;
$form_state['transaction'] = $transaction;
// Load and store the payment method instance for this transaction.
$payment_method = commerce_payment_method_instance_load($transaction->instance_id);
$form_state['payment_method'] = $payment_method;
$form['markup'] = array(
'#markup' => t('Are you sure that you want to void this transaction?'),
);
$form = confirm_form($form, t('Are you sure that you want to void this transaction?'), 'admin/commerce/orders/' . $order->order_id . '/payment', '', t('Void'), t('Cancel'), 'confirm');
return $form;
}
/**
* Submit handler: process the void request.
*/
function commerce_authnet_aim_void_form_submit($form, &$form_state) {
$transaction = $form_state['transaction'];
// Build a name-value pair array for this transaction.
$nvp = array(
'x_type' => 'VOID',
'x_trans_id' => $transaction->remote_id,
);
// Submit the request to Authorize.Net.
$response = commerce_authnet_aim_request($form_state['payment_method'], $nvp);
// Update and save the transaction based on the response.
$transaction->payload[REQUEST_TIME] = $response;
// If we got an approval response code...
if ($response[0] == 1) {
drupal_set_message(t('Transaction successfully voided.'));
// Set the remote and local status accordingly.
$transaction->status = COMMERCE_PAYMENT_STATUS_FAILURE;
$transaction->remote_status = $response[11];
// Update the transaction message to show that it has been voided.
$transaction->message .= '<br />' . t('Voided: @date', array(
'@date' => format_date(REQUEST_TIME, 'short'),
));
// Zero out transaction amount before saving,
// so original amount is not saved as a positive revenue transaction.
// Authorize.Net settles these as "0.00" (see the payload on a void response).
$transaction->amount = '000';
}
else {
drupal_set_message(t('Void failed: @reason', array(
'@reason' => check_plain($response[3]),
)), 'error');
}
commerce_payment_transaction_save($transaction);
$form_state['redirect'] = 'admin/commerce/orders/' . $form_state['order']->order_id . '/payment';
}
/**
* Form callback: allows the user to issue a credit on a prior transaction.
*/
function commerce_authnet_aim_credit_form($form, &$form_state, $order, $transaction) {
$form_state['order'] = $order;
$form_state['transaction'] = $transaction;
// Load and store the payment method instance for this transaction.
$payment_method = commerce_payment_method_instance_load($transaction->instance_id);
$form_state['payment_method'] = $payment_method;
$default_amount = number_format(commerce_currency_amount_to_decimal($transaction->amount, $transaction->currency_code), 2, '.', '');
$form['amount'] = array(
'#type' => 'textfield',
'#title' => t('Credit amount'),
'#description' => t('Enter the amount to be credited back to the original credit card.'),
'#default_value' => $default_amount,
'#field_suffix' => check_plain($transaction->currency_code),
'#size' => 16,
);
$form = confirm_form($form, t('What amount do you want to credit?'), 'admin/commerce/orders/' . $order->order_id . '/payment', '', t('Credit'), t('Cancel'), 'confirm');
return $form;
}
/**
* Validate handler: check the credit amount before attempting credit request.
*/
function commerce_authnet_aim_credit_form_validate($form, &$form_state) {
$transaction = $form_state['transaction'];
$amount = $form_state['values']['amount'];
// Ensure a positive numeric amount has been entered for credit.
if (!is_numeric($amount) || $amount <= 0) {
form_set_error('amount', t('You must specify a positive numeric amount to credit.'));
}
// Ensure the amount is less than or equal to the captured amount.
if ($amount > commerce_currency_amount_to_decimal($transaction->amount, $transaction->currency_code)) {
form_set_error('amount', t('You cannot credit more than you captured through Authorize.Net.'));
}
// If the transaction is older than 120 days, display an error message and redirect.
if (time() - $transaction->created > 86400 * 120) {
drupal_set_message(t('This capture has passed its 120 day limit for issuing credits.'), 'error');
drupal_goto('admin/commerce/orders/' . $form_state['order']->order_id . '/payment');
}
}
/**
* Submit handler: process a credit via AIM.
*/
function commerce_authnet_aim_credit_form_submit($form, &$form_state) {
$transaction = $form_state['transaction'];
$amount = number_format($form_state['values']['amount'], 2, '.', '');
$order = $form_state['order'];
$payment_method = $form_state['payment_method'];
// Determine the last 4 credit card digits from the previous transaction.
$transaction_payload = end($transaction->payload);
// If this payment transaction does not have credit card digits, we will check
// for a previous transaction that has the information.
if (empty($transaction_payload[50])) {
// We reverse the array because Voids do not contain credit card digits,
// and we will have to cycle through fewer transactions this way.
$transaction_payloads = array_reverse($transaction->payload);
foreach ($transaction_payloads as $transaction_id => $payload) {
if ($payload[0] == 1 && !empty($payload[50])) {
// This payload has the last four digits.
$transaction_payload = $payload;
break;
}
}
}
$credit_card = !empty($transaction_payload[50]) ? substr($transaction_payload[50], 4, 8) : '';
// Make sure that the last 4 digits are available and valid.
if (!intval($credit_card) || strlen($credit_card) != 4) {
drupal_set_message(t('The credit could not be attempted, because the last 4 digits of the credit card were not found in the transaction data. Please login to your Authorize.Net merchant interface to issue the credit.'));
return FALSE;
}
else {
// Build a name-value pair array for this transaction.
$nvp = array(
'x_type' => 'CREDIT',
'x_trans_id' => $transaction->remote_id,
'x_amount' => $amount,
'x_card_num' => $credit_card,
'x_invoice_num' => $order->order_number,
'x_email' => substr($order->mail, 0, 255),
'x_cust_id' => substr($order->uid, 0, 20),
'x_customer_ip' => substr(ip_address(), 0, 15),
);
// Submit the request to Authorize.Net.
$response = commerce_authnet_aim_request($form_state['payment_method'], $nvp);
// If the credit succeeded...
if ($response[0] == 1) {
$credit_amount = commerce_currency_decimal_to_amount($amount, $transaction->currency_code);
drupal_set_message(t('Credit for @amount issued successfully', array(
'@amount' => commerce_currency_format($credit_amount, $transaction->currency_code),
)));
// Create a new transaction to record the credit.
$credit_transaction = commerce_payment_transaction_new('authnet_aim', $order->order_id);
$credit_transaction->instance_id = $payment_method['instance_id'];
$credit_transaction->remote_id = $response[6];
$credit_transaction->amount = $credit_amount * -1;
$credit_transaction->currency_code = $transaction->currency_code;
$credit_transaction->payload[REQUEST_TIME] = $response;
$credit_transaction->status = COMMERCE_PAYMENT_STATUS_SUCCESS;
$credit_transaction->remote_status = $response[11];
$credit_transaction->message = t('Credited to @remote_id.', array(
'@remote_id' => $transaction->remote_id,
));
// Save the credit transaction.
commerce_payment_transaction_save($credit_transaction);
}
else {
// Save the failure response message to the original transaction.
$transaction->payload[REQUEST_TIME] = $response;
// Display a failure message and response reason from Authorize.net.
drupal_set_message(t('Credit failed: @reason', array(
'@reason' => $response[3],
)), 'error');
// Add an additional helper message if the transaction hadn't settled yet.
if ($response[2] == 54) {
drupal_set_message(t('The transaction must be setted before a credit can be issued. This usually takes 24 hours'), 'error');
}
commerce_payment_transaction_save($transaction);
}
}
$form_state['redirect'] = 'admin/commerce/orders/' . $order->order_id . '/payment';
}Functions
Name |
Description |
|---|---|
| commerce_authnet_aim_capture_form | Form callback: allows the user to capture a prior authorization. |
| commerce_authnet_aim_capture_form_submit | Submit handler: process a prior authorization capture via AIM. |
| commerce_authnet_aim_capture_form_validate | Validate handler: ensure a valid amount is given. |
| commerce_authnet_aim_credit_form | Form callback: allows the user to issue a credit on a prior transaction. |
| commerce_authnet_aim_credit_form_submit | Submit handler: process a credit via AIM. |
| commerce_authnet_aim_credit_form_validate | Validate handler: check the credit amount before attempting credit request. |
| commerce_authnet_aim_void_form | Form callback: allows the user to void a transaction. |
| commerce_authnet_aim_void_form_submit | Submit handler: process the void request. |