iATS Payments API PHP Wrapper
Back to top  

ReportLink

Extends \iATS\Core

Class ReportLink

package

iATS

Methods

IATS class constructor.

__construct(string $agentcode, string $password, string $serverid = 'NA')
inherited
see \iATS\Core::setServer()

For options

Arguments

$agentcode

string

iATS account agent code.

$password

string

iATS account password.

$serverid

string

Server identifier. (Defaults to 'NA')

Make web service requests to the iATS API.

apiCall(string $method, array $parameters) : object
inherited
throws

Arguments

$method

string

The name of the method to call.

$parameters

array

Parameters to pass the API.

Response

object

XML object or boolean.

Check Method of Payment (MOP) is available based on server and currency.

checkMOPCurrencyRestrictions(string $serverid, string $currency, string $mop) : boolean
inherited

Arguments

$serverid

string

Server identifier

$currency

string

Currency

$mop

string

Method of Payment

Response

boolean

Result of check

Check restrictions for service.

checkRestrictions(array $parameters, boolean $forceCurrencyCheck = FALSE) : boolean|string
inherited

Arguments

$parameters

array

Request parameters.

$forceCurrencyCheck

boolean

True to force a currency check even when currency or method of payment are missing.

Response

boolean|string

FALSE if no restrictions. Message if restricted.

Check server restrictions.

checkServerRestrictions(string $serverid, array $restrictedservers) : boolean
inherited

Arguments

$serverid

string

Server identifier

$restrictedservers

array

Restricted servers array

Response

boolean

Result of server restricted check

Get ACH/EFT Payment Box approved transactions CSV report.

getACHEFTApprovedDateRangeCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'fromDate' => '2014-07-23T00:00:00+00:00' // The earliest date to gather report data for. 'toDate' => '2024-07-23T23:59:59+00:00' // The latest date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address. 'startIndex' => '0' // Optional. 'endIndex' => '1' // Optional.

Response

mixed

Report CSV (string) or API error.

Get ACH / EFT approved transactions CSV report.

getACHEFTApprovedSpecificDateCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get ACH / EFT approved transactions report.

getACHEFTApprovedSpecificDateXML(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report array or API error.

Get ACH / EFT Bank Reconciliation CSV report.

getACHEFTBankReconciliationReportCSV(array $parameters) : mixed

Provides a report of the bank balance of ACHEFT transactions.

Arguments

$parameters

array

An associative array with the following possible values. 'fromDate' => '2014-07-23T00:00:00+00:00' // The earliest date to gather report data for. 'toDate' => '2024-07-23T23:59:59+00:00' // The latest date to gather report data for. 'currency' => 'USD' // The currency to represent financial data as. // North America options: CAD, USD // UK options: USD, EUR, GBP, IEE, CHF, HKD, JPY, SGD, MXN 'summaryOnly' => FALSE // True when a summarized report is required. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get ACH / EFT Payment Box Reject CSV report.

getACHEFTRejectDateRangeCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'fromDate' => '2014-07-23T00:00:00+00:00' // The earliest date to gather report data for. 'toDate' => '2024-07-23T23:59:59+00:00' // The latest date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address. 'startIndex' => '0' // Optional. 'endIndex' => '1' // Optional.

Response

mixed

Report CSV (string) or API error.

Get ACH / EFT Reject CSV report.

getACHEFTRejectSpecificDateCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get ACH / EFT Reject report.

getACHEFTRejectSpecificDateXML(array $parameters) : mixed
endcode

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report array or API error.

Get ACH / EFT Payment Return Date Range CSV report.

getACHEFTReturnDateRangeCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'fromDate' => '2014-07-23T00:00:00+00:00' // The earliest date to gather report data for. 'toDate' => '2024-07-23T23:59:59+00:00' // The latest date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get ACH / EFT Return CSV report.

getACHEFTReturnSpecificDateCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get ACH / EFT Return report.

getACHEFTReturnSpecificDateXML(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report array or API error.

Get Credit Card Payment Box approved transactions CSV report.

getCreditCardApprovedDateRangeCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'fromDate' => '2014-07-23T00:00:00+00:00' // The earliest date to gather report data for. 'toDate' => '2024-07-23T23:59:59+00:00' // The latest date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address. 'startIndex' => '0' // Optional. 'endIndex' => '1' // Optional.

Response

mixed

Report CSV (string) or API error.

Get Credit Card approved transactions CSV report.

getCreditCardApprovedSpecificDateCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get Credit Card approved transactions report.

getCreditCardApprovedSpecificDateXML(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report array or API error.

Get Credit Card Bank Reconciliation CSV report.

getCreditCardBankReconciliationReportCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'fromDate' => '2014-07-23T00:00:00+00:00' // The earliest date to gather report data for. 'toDate' => '2024-07-23T23:59:59+00:00' // The latest date to gather report data for. 'currency' => 'USD' // The currency to represent financial data as. // North America options: CAD, USD // UK options: USD, EUR, GBP, IEE, CHF, HKD, JPY, SGD, MXN 'summaryOnly' => FALSE // True when a summerized report is required. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get Credit Card Payment Box Reject CSV report.

getCreditCardRejectDateRangeCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'fromDate' => '2014-07-23T00:00:00+00:00' // The earliest date to gather report data for. 'toDate' => '2024-07-23T23:59:59+00:00' // The latest date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address. 'startIndex' => '0' // Optional. 8 'endIndex' => '1' // Optional.

Response

mixed

Report CSV (string) or API error.

Get Credit Card Reject CSV report.

getCreditCardRejectSpecificDateCSV(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report CSV (string) or API error.

Get Credit Card Reject report.

getCreditCardRejectSpecificDateXML(array $parameters) : mixed

Arguments

$parameters

array

An associative array with the following possible values. 'date' => '2014-07-23T00:00:00+00:00' // The date to gather report data for. 'customerIPAddress' => '' // Optional. The client's IP address.

Response

mixed

Report array or API error.

Converts a UNIX timestamp to a date string formatted for SOAP requests.

getFormattedDate(integer $timestamp) : string
inherited

Arguments

$timestamp

integer

The timestamp to convert.

Response

string

The formatted date string.

MOP Currency matrix.

getMOPCurrencyMatrix() : array
inherited

Response

array

Array of Server/Currency/MOP

Create SoapClient object.

getSoapClient(string $endpoint, array $options = array()) : \SoapClient
inherited

Arguments

$endpoint

string

Service endpoint

$options

array

SoapClient options @see http://www.php.net/manual/en/soapclient.soapclient.php

Response

\SoapClient

Returns IATS SoapClient object

Return a rejection message for a given code.

rejectMessage(integer $reject_code) : array
inherited

Arguments

$reject_code

integer

iATS rejection code.

Response

array

Rejection code and message as in array in the format: [ 'code' => 19, 'message' => 'Incorrect CVV2 security code', ]

Response Handler for ReportLink calls.

responseHandler(object $response, string $result, string $format) : mixed

Arguments

$response

object

SOAP response

$result

string

Result string

$format

string

Output format. 'AR' will return array(), 'CSV' will return a comma delimited data string with headers.

Response

mixed

Response

Set the server to use based on a server id.

setServer(string $serverid)
inherited
throws

Arguments

$serverid

string

Server identifier ('UK' or 'NA'.)

Convert an XML string to an array.

xml2array(string $xmlstring) : array
inherited

Arguments

$xmlstring

string

An XML string to be processed.

Response

array

Array.

Properties

North America server url.

na_server : string
inherited
var

North America server url.

Type(s)

string

UK server url.

uk_server : string
inherited
var

UK server url.

Type(s)

string

iATS account agent code.

agentcode : string
inherited
var

iATS account agent code.

Type(s)

string

iATS account password.

password : string
inherited
var

iATS account password.

Type(s)

string

Server identifier. @see Core::setServer()

serverid : string
inherited
var

Server identifier.

@see Core::setServer()

Type(s)

string

Server url.

server : string
inherited
var

Server url.

Type(s)

string

Service endpoint

endpoint : string
inherited
var

Service endpoint

Type(s)

string

Requrest parameters

params : string
inherited
var

Requrest parameters

Type(s)

string

The result name

resultname : string
inherited
var

The result name

Type(s)

string

Format

format : string
inherited
var

Format

Type(s)

string

Restricted servers array

restrictedservers : array
inherited
var

Restricted servers array

Type(s)

array