topic Re: PHP API setTransactionSettings - duplicateWIndow in Integration and Testing

PHP API setTransactionSettings - duplicateWIndow

fifty-git — Thu, 01 Dec 2016 21:35:55 GMT

Hi, I am trying to set the duplicateWindow time using:

$transactionRequestType->setTransactionSettings();

I found this in the PHP SDK code on this page >>

public function setTransactionSettings(array $transactionSettings) {}

That tells me this method accepts an array, but I'm not sure how to format the data I send.

I found the XML version:

<transactionSettings>
<setting>
<settingName>duplicateWindow</settingName>
<settingValue>0</settingValue>
</setting>
</transactionSettings>

But I'm not sure how to translate that into a PHP array.

Thanks,

- Don

Re: PHP API setTransactionSettings - duplicateWIndow

Aaron — Fri, 02 Dec 2016 18:30:05 GMT

Hi Don,

Instead of calling that method directly, we have other methods that allow you to add settings to the array that eventually gets used to build the transaction. For duplicateWindow specifically, you'd do something like this:

First, you'll need to create a variable of type "SettingType", then add the SettingName and SettingValue to that variable using the "setSettingName" and "setSettingValue" methods, like so:

//add the values for transaction settings
$duplicateWindowSetting = new AnetAPI\SettingType();
$duplicateWindowSetting->setSettingName("duplicateWindow");
$duplicateWindowSetting->setSettingValue("600");

Then, add the settings to the TransactionRequestType values that you're building using the "addToTransactionSettings" method:

$transactionRequestType->addToTransactionSettings($duplicateWindowSetting);

Other transaction settings are set the same way.

Let us know if you have any other questions!

Re: PHP API setTransactionSettings - duplicateWIndow

fifty-git — Fri, 02 Dec 2016 19:55:15 GMT

That's exactly what I was looking for. Thank you. I'll post my results later.

- Don

Re: PHP API setTransactionSettings - duplicateWIndow

fifty-git — Fri, 09 Dec 2016 19:14:42 GMT

How could I use this method to set multiple settingNames?

Thanks,

Don

Re: PHP API setTransactionSettings - duplicateWIndow

Aaron — Fri, 09 Dec 2016 23:00:33 GMT

Hi Don,

It would be pretty similar, just making a new instance of class SettingType() for each different setting you wanted. Something like

//add the values for each setting
$duplicateWindowSetting = new AnetAPI\SettingType();
$duplicateWindowSetting->setSettingName("duplicateWindow");
$duplicateWindowSetting->setSettingValue("600");

$allowPartialAuthSetting = new AnetAPI\SettingType();
$allowPartialAuthSetting->setSettingName("allowPartialAuth");
$allowPartialAuthSetting->setSettingValue("true");

and so on, then adding each transaction setting to the transaction request by doing something like:

$transactionRequestType->addToTransactionSettings($duplicateWindowSetting);
$transactionRequestType->addToTransactionSettings($allowPartialAuthSetting);

Re: PHP API setTransactionSettings - duplicateWIndow

fifty-git — Wed, 14 Dec 2016 20:11:41 GMT

Thank you for you help!

- Don

Re: PHP API setTransactionSettings - duplicateWIndow

SergeiP — Fri, 30 Dec 2016 18:40:35 GMT

$transactionRequestType->addToTransactionSettings($duplicateWindowSetting);

this has changed a bit. Now you need to pass an array

$transactionRequestType->addToTransactionSettings([$duplicateWindowSetting]);

Re: PHP API setTransactionSettings - duplicateWIndow

fifty-git — Fri, 06 Jan 2017 15:20:45 GMT

Perhaps this is the new SDK, which I need to update to soon.

If I try to pass the setting as an array now, it causes an error.

Can you show more code to clarify?

Thanks,

Don

Re: PHP API setTransactionSettings - duplicateWIndow

Aaron — Fri, 06 Jan 2017 17:20:17 GMT

The addToTransactionSettings method expects as its argument an instance of "SettingType", so passing an array will fail.

"SettingType" is in fact an array defined elsewhere in the SDK, but since it's defined as its own datatype, you've got to pass addToTransactionSettings something that it will recognize as a SettingType.

In my sample code above, I first declare $duplicateWindowSetting as a "SettingType":

$duplicateWindowSetting = new AnetAPI\SettingType();

Then I add some data, and after that pass it to the addToTransactionSettings method:

$transactionRequestType->addToTransactionSettings($duplicateWindowSetting);

@fifty-git, even in the latest SDK you shouldn't need to pass an array as long as you're following this pattern.

Re: PHP API setTransactionSettings - duplicateWIndow

fifty-git — Fri, 06 Jan 2017 19:12:30 GMT

very cool, thank you Aaron!

Re: PHP API setTransactionSettings - duplicateWIndow

MikeSki — Thu, 07 Sep 2017 14:32:58 GMT

Where can I find coumentation explaining the different transactionSettings?

Thanks in advance.

Re: PHP API setTransactionSettings - duplicateWIndow

Aaron — Thu, 07 Sep 2017 20:41:34 GMT

Hi @MikeSki,

My apologies, but it looks like all values didn't make it into the documentation. I'll make sure that's corrected. In the meantime, here's the information we have from our internal documentation:

Possible values of settingName:

emailCustomer
headerEmailReceipt
footerEmailReceipt
allowPartialAuth
duplicateWindow
recurringBilling

emailCustomer - indicates whether to send a receipt to the email address specified in the customer section of this transaction (boolean).

headerEmailReceipt - This text appears as the header of the email receipt sent to the customer (string).

footerEmailReceipt - This text appears as the footer on the email receipt sent to the customer (string).

allowPartialAuth - Indicates whether the transaction is enabled for partial authorization for split tender transactions (boolean)

duplicateWindow - Indicates in seconds the period of time after a transaction is submitted during which the payment gateway checks for a duplicate transaction (string). The maximum time allowed is 8 hours (28800 seconds).

recurringBilling - Indicates the transaction has originated from merchant hosted recurring billing applications (boolean). Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.