APIs

This is the details of all APIs and functions regarding Forte Payment Systems of this SDK.

Address

The following functions are available:

setStreetLine1 ($street_line1)

Parameters:
$street_line1 (string) – Street Line1
Return type: Object

getStreetLine1 ()

Return type: String

setStreetLine2 ($street_line2)

Parameters:
$street_line2 (string) – Street Line2
Return type: Object

getStreetLine2 ()

Return type: String

setLocality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getLocality ()

Return type: String

setRegion ($region)

Parameters:
$region (string) – Region
Return type: Object

getRegion ()

Return type: String

setCountry ($country)

Parameters:
$country (string) – Country
Return type: Object

getCountry ()

Return type: String

setPostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getPostalCode ()

Return type: String

setLabel ($label)

Parameters:
$label (string) – Label
Return type: Object

getLabel ()

Return type: String

setFirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getFirstName ()

Return type: String

setLastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getLastName ()

Return type: String

setCompanyName ($company_name)

Parameters:
$company_name (string) – Company Name
Return type: Object

getCompanyName ()

Return type: String

setPhone ($phone)

Parameters:
$phone (string) – Phone
Return type: Object

getPhone ()

Return type: String

setEmail ($email)

Parameters:
$email (string) – Email
Return type: Object

getEmail ()

Return type: String

setShippingAddressType ($shipping_address_type)

Parameters:
$shipping_address_type (string) – Shipping Address Type
Return type: Object

getShippingAddressType ()

Return type: String

setAddressType ($address_type)

Parameters:
$address_type (string) – Address Type
Return type: Object

getAddressType ()

Return type: String

getAddressToken ()

Return type: String

getAddressById ()

Return type: String

getAddressByCustomerToken ()

Return type: String

getAllAddressForLocation ()

Return type: String

getAllAddressForOrganization ()

Return type: String

create ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

createAddressAltURI ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

update ($customer_token, $address_token)

Parameters:
$customer_token (string) – Customer Token $address_token (string) – Address Token
Return type: Object

delete ($address_token)

Parameters:
$address_token (string) – Address Token
Return type: Object

Application

The following functions are available:

setFeeId ($fee_id)

Parameters:
$fee_id (string) – Fee Id
Return type: Object

getFeeId ()

Return type: String

setSourceIp ($source_ip)

Parameters:
$source_ip (string) – Source Ip
Return type: Object

getSourceIp ()

Return type: String

setAnnualVolume ($annual_volume)

Parameters:
$annual_volume (string) – Annual Volume
Return type: Object

getAnnualVolume ()

Return type: String

setAverageTransactionAmount ($average_transaction_amount)

Parameters:
$average_transaction_amount (string) – Average Transaction Amount
Return type: Object

getAverageTransactionAmount ()

Return type: String

setMarketType ($market_type)

Parameters:
$market_type (string) – Market Type
Return type: Object

getMarketType ()

Return type: String

setTermsAndConditionVersion ($t_and_c_version)

Parameters:
$t_and_c_version (string) – Terms and Condition Version
Return type: Object

getTermsAndConditionVersion ()

Return type: String

setTermsAndConditionTimestamp ($t_and_c_time_stamp)

Parameters:
$t_and_c_time_stamp (string) – Terms and Condition Time Stamp
Return type: Object

getTermsAndConditionTimestamp ()

Return type: String

setRiskSessionId ($risk_session_id)

Parameters:
$risk_session_id (string) – Risk Session Id
Return type: Object

getRiskSessionId ()

Return type: String

setMaximumTransactionAmount ($maximum_transaction_amount)

Parameters:
$maximum_transaction_amount (string) – Maximum Transaction Amount
Return type: Object

getMaximumTransactionAmount ()

Return type: String

setAveragePayableAmount ($average_payable_amount)

Parameters:
$average_payable_amount (string) – Average Payable Amount
Return type: Object

getAveragePayableAmount ()

Return type: String

setMaximumPayableAmount ($maximum_payable_amount)

Parameters:
$maximum_payable_amount (string) – Maximum Payable Amount
Return type: Object

getMaximumPayableAmount ()

Return type: String

setMonthlyPayableVolume ($monthly_payable_volume)

Parameters:
$monthly_payable_volume (string) – Monthly Payable Volume
Return type: Object

getMonthlyPayableVolume ()

Return type: String

setRecievedDate ($received_date)

Parameters:
$received_date (string) – Received Date
Return type: Object

getRecievedDate ()

Return type: String

setUpdatedDate ($updated_date)

Parameters:
$updated_date (string) – Updated Date
Return type: Object

getUpdatedDate ()

Return type: String

setSalesRep ($sales_rep)

Parameters:
$sales_rep (string) – Sales Rep
Return type: Object

getSalesRep ()

Return type: String

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setStatus ($status)

Parameters:
$status (string) – Status
Return type: Object

getStatus ()

Return type: String

setDeclineReason ($decline_reason)

Parameters:
$decline_reason (string) – Decline Reason
Return type: Object

getDeclineReason ()

Return type: String

setLegalName ($legal_name)

Parameters:
$legal_name (string) – Legal Name
Return type: Object

getLegalName ()

Return type: String

setTaxIdNumber ($tax_id_number)

Parameters:
$tax_id_number (string) – Tax Id Number
Return type: Object

getTaxIdNumber ()

Return type: String

setLegalStructure ($legal_structure)

Parameters:
$legal_structure (string) – Legal Structure
Return type: Object

getLegalStructure ()

Return type: String

setDbaName ($dba_name)

Parameters:
$dba_name (string) – Dba Name
Return type: Object

getDbaName ()

Return type: String

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setStreetAddress1 ($street_address1)

Parameters:
$street_address1 (string) – Street Address1
Return type: Object

getStreetAddress1 ()

Return type: String

setLocality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getLocality ()

Return type: String

setRegion ($region)

Parameters:
$region (string) – Region
Return type: Object

getRegion ()

Return type: String

setPostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getPostalCode ()

Return type: String

setCustomerServicePhone ($customer_service_phone)

Parameters:
$customer_service_phone (string) – Customer Service Phone
Return type: Object

getCustomerServicePhone ()

Return type: String

setWebsite ($website)

Parameters:
$website (string) – Website
Return type: Object

getWebsite ()

Return type: String

setBusinessType ($business_type)

Parameters:
$business_type (string) – Business Type
Return type: Object

getBusinessType ()

Return type: String

setBankAcountType ($bank_account_type)

Parameters:
$bank_account_type (string) – Bank Account Type
Return type: Object

getBankAcountType ()

Return type: String

setBankRoutingNumber ($bank_routing_number)

Parameters:
$bank_routing_number (string) – Bank Routing Number
Return type: Object

getBankRoutingNumber ()

Return type: String

setBankAccountNumber ($bank_account_number)

Parameters:
$bank_account_number (string) – Bank Account Number
Return type: Object

getBankAccountNumber ()

Return type: String

setOwnerPercentage ($percentage)

Parameters:
$percentage (string) – Percentage
Return type: Object

getOwnerPercentage ()

Return type: String

setOwnerTitle ($title)

Parameters:
$title (string) – Title
Return type: Object

getOwnerTitle ()

Return type: String

setOwnerFirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getOwnerFirstName ()

Return type: String

setOwnerLastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getOwnerLastName ()

Return type: String

setOwnerStreetAddress1 ($street_address1)

Parameters:
$street_address1 (string) – Street Address1
Return type: Object

getOwnerStreetAddress1 ()

Return type: String

setOwnerLocality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getOwnerLocality ()

Return type: String

setOwnerRegion ($region)

Parameters:
$region (string) – Region
Return type: Object

getOwnerRegion ()

Return type: String

setOwnerPostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getOwnerPostalCode ()

Return type: String

setOwnerCountry ($country)

Parameters:
$country (string) – Country
Return type: Object

getOwnerCountry ()

Return type: String

setOwnerCitizenship ($citizenship)

Parameters:
$citizenship (string) – Citizenship
Return type: Object

getOwnerCitizenship ()

Return type: String

setOwnerEmailAddress ($email_address)

Parameters:
$email_address (string) – Email Address
Return type: Object

getOwnerEmailAddress ()

Return type: String

setOwnerMobilePhone ($mobile_phone)

Parameters:
$mobile_phone (string) – Mobile Phone
Return type: Object

getOwnerMobilePhone ()

Return type: String

setOwnerLast4ssn ($last4_ssn)

Parameters:
$last4_ssn (string) – Last 4 SSN
Return type: Object

getOwnerLast4ssn ()

Return type: String

setOwnerDateOfBirth ($date_of_birth)

Parameters:
$date_of_birth (string) – Date Of Birth
Return type: Object

getOwnerDateOfBirth ()

Return type: String

setOwner2Percentage ($percentage)

Parameters:
$percentage (string) – Percentage
Return type: Object

getOwner2Percentage ()

Return type: String

setOwner2FirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getOwner2FirstName ()

Return type: String

setOwner2LastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getOwner2LastName ()

Return type: String

setOwner2StreetAddress1 ($street_address1)

Parameters:
$street_address1 (string) – Street Address1
Return type: Object

getOwner2StreetAddress1 ()

Return type: String

setOwner2Locality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getOwner2Locality ()

Return type: String

setOwner2Region ($region)

Parameters:
$region (string) – Region
Return type: Object

getOwner2Region ()

Return type: String

setOwner2PostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getOwner2PostalCode ()

Return type: String

setOwner2Country ($country)

Parameters:
$country (string) – Country
Return type: Object

getOwner2Country ()

Return type: String

setOwner2Citizenship ($citizenship)

Parameters:
$citizenship (string) – Citizenship
Return type: Object

getOwner2Citizenship ()

Return type: String

setOwner2EmailAddress ($email_address)

Parameters:
$email_address (string) – Email Address
Return type: Object

getOwner2EmailAddress ()

Return type: String

setOwner2MobilePhone ($mobile_phone)

Parameters:
$mobile_phone (string) – Mobile Phone
Return type: Object

getOwner2MobilePhone ()

Return type: String

setOwner2Last4ssn ($last4_ssn)

Parameters:
$last4_ssn (string) – Last 4 SSN
Return type: Object

getOwner2Last4ssn ()

Return type: String

setOwner2DateOfBirth ($date_of_birth)

Parameters:
$date_of_birth (string) – Date Of Birth
Return type: Object

getOwner2DateOfBirth ()

Return type: String

setOwner3Percentage ($percentage)

Parameters:
$percentage (string) – Percentage
Return type: Object

getOwner3Percentage ()

Return type: String

setOwner3FirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getOwner3FirstName ()

Return type: String

setOwner3LastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getOwner3LastName ()

Return type: String

setOwner3StreetAddress1 ($street_address1)

Parameters:
$street_address1 (string) – Street Address1
Return type: Object

getOwner3StreetAddress1 ()

Return type: String

setOwner3Locality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getOwner3Locality ()

Return type: String

setOwner3Region ($region)

Parameters:
$region (string) – Region
Return type: Object

getOwner3Region ()

Return type: String

setOwner3PostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getOwner3PostalCode ()

Return type: String

setOwner3Country ($country)

Parameters:
$country (string) – Country
Return type: Object

getOwner3Country ()

Return type: String

setOwner3Citizenship ($citizenship)

Parameters:
$citizenship (string) – Citizenship
Return type: Object

getOwner3Citizenship ()

Return type: String

setOwner3EmailAddress ($email_address)

Parameters:
$email_address (string) – Email Address
Return type: Object

getOwner3EmailAddress ()

Return type: String

setOwner3MobilePhone ($mobile_phone)

Parameters:
$mobile_phone (string) – Mobile Phone
Return type: Object

getOwner3MobilePhone ()

Return type: String

setOwner3Last4ssn ($last4_ssn)

Parameters:
$last4_ssn (string) – Last 4 SSN
Return type: Object

getOwner3Last4ssn ()

Return type: String

setOwner3DateOfBirth ($date_of_birth)

Parameters:
$date_of_birth (string) – Date Of Birth
Return type: Object

getOwner3DateOfBirth ()

Return type: String

setOwner4Percentage ($percentage)

Parameters:
$percentage (string) – Percentage
Return type: Object

getOwner4Percentage ()

Return type: String

setOwner4FirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getOwner4FirstName ()

Return type: String

setOwner4LastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getOwner4LastName ()

Return type: String

setOwner4StreetAddress1 ($street_address1)

Parameters:
$street_address1 (string) – Street Address1
Return type: Object

getOwner4StreetAddress1 ()

Return type: String

setOwner4Locality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getOwner4Locality ()

Return type: String

setOwner4Region ($region)

Parameters:
$region (string) – Region
Return type: Object

getOwner4Region ()

Return type: String

setOwner4PostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getOwner4PostalCode ()

Return type: String

setOwner4Country ($country)

Parameters:
$country (string) – Country
Return type: Object

getOwner4Country ()

Return type: String

setOwner4Citizenship ($citizenship)

Parameters:
$citizenship (string) – Citizenship
Return type: Object

getOwner4Citizenship ()

Return type: String

setOwner4EmailAddress ($email_address)

Parameters:
$email_address (string) – Email Address
Return type: Object

getOwner4EmailAddress ()

Return type: String

setOwner4MobilePhone ($mobile_phone)

Parameters:
$mobile_phone (string) – Mobile Phone
Return type: Object

getOwner4MobilePhone ()

Return type: String

setOwner4Last4ssn ($last4_ssn)

Parameters:
$last4_ssn (string) – Last 4 SSN
Return type: Object

getOwner4Last4ssn ()

Return type: String

setOwner4DateOfBirth ($date_of_birth)

Parameters:
$date_of_birth (string) – Date Of Birth
Return type: Object

getOwner4DateOfBirth ()

Return type: String

setProvider ($provider)

Parameters:
$provider (string) – Provider
Return type: Object

getProvider ()

Return type: String

setBankIdNumber ($bank_id_number)

Parameters:
$bank_id_number (string) – Bank Id Number
Return type: Object

getBankIdNumber ()

Return type: String

setMerchantId ($merchant_id)

Parameters:
$merchant_id (string) – Merchant Id
Return type: Object

getMerchantId ()

Return type: String

setTerminalId ($terminal_id)

Parameters:
$terminal_id (string) – Terminal Id
Return type: Object

getTerminalId ()

Return type: String

setAgent ($agent)

Parameters:
$agent (string) – Agent
Return type: Object

getAgent ()

Return type: String

setChain ($chain)

Parameters:
$chain (string) – Chain
Return type: Object

getChain ()

Return type: String

setStore ($store)

Parameters:
$store (string) – Store
Return type: Object

getStore ()

Return type: String

setTerminal ($terminal)

Parameters:
$terminal (string) – Terminal
Return type: Object

getTerminal ()

Return type: String

getApplicationId ()

Return type: String

create ()

Return type: Object

getApplicationById ($application_id)

Parameters:
$application_id (string) – Application Id
Return type: Object

getApplicationByDate ($start_date, $end_date)

Parameters:
$start_date (string) – Start Date $end_date (string) – End Date
Return type: Object

BankAccount()

The following functions are available:

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setRoutingNumber ($routing_number)

Parameters:
$routing_number (string) – Routing Number
Return type: Object

getRoutingNumber ()

Return type: String

setAccountNumber ($account_number)

Parameters:
$account_number (string) – Account Number
Return type: Object

getAccountNumber ()

Return type: String

setLast4AccountNumber ($last_4_account_number)

Parameters:
$last_4_account_number (string) – Last 4 Account Number
Return type: Object

getLast4AccountNumber ()

Return type: String

setAccountType ($account_type)

Parameters:
$account_type (string) – Account Type
Return type: Object

getAccountType ()

Return type: String

setLabel ($label)

Parameters:
$label (string) – Label
Return type: Object

getLabel ()

Return type: String

setBankAccountToken ($bank_account_token)

Parameters:
$bank_account_token (string) – Bank Account Token
Return type: Object

getBankAccountToken ()

Return type: String

setStatus ($status)

Parameters:
$status (string) – Status
Return type: Object

getStatus ()

Return type: String

create ()

Return type: Object

getBankAccount ($bank_account_token)

Parameters:
$bank_account_token (string) – Bank Account Token
Return type: Object

delete ($bank_account_token)

Parameters:
$bank_account_token (string) – Bank Account Token
Return type: Object

Customer()

The following functions are available:

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getCustomerToken ()

Return type: String

setCustomerId ($customer_id)

Parameters:
$customer_id (string) – Customer Id
Return type: Object

getCustomerId ()

Return type: String

setDefaultPaymethodToken ($default_paymethod_token)

Parameters:
$default_paymethod_token (string) – Default Paymethod Token
Return type: Object

getDefaultPaymethodToken ()

Return type: String

setDefaultBillingAddressToken ($default_billing_address_token)

Parameters:
$default_billing_address_token (string) – Default Billing Address Token
Return type: Object

getDefaultBillingAddressToken ()

Return type: String

setDefaultShippingAddressToken ($default_shipping_address_token)

Parameters:
$default_shipping_address_token (string) – Default Shipping Address Token
Return type: Object

getDefaultShippingAddressToken ()

Return type: String

setFirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getFirstName ()

Return type: String

setLastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getLastName ()

Return type: String

setCompanyName ($company_name)

Parameters:
$company_name (string) – Company Name
Return type: Object

getCompanyName ()

Return type: String

setStatus ($status)

Parameters:
$status (string) – Status
Return type: Object

getStatus ()

Return type: String

setDisplayName ($display_name)

Parameters:
$display_name (string) – Display Name
Return type: Object

getDisplayName ()

Return type: String

setCreatedDate ($created_date)

Parameters:
$created_date (string) – Created Date
Return type: Object

getCreatedDate ()

Return type: String

setUpdatedDate ($updated_date)

Parameters:
$updated_date (string) – Updated Date
Return type: Object

getUpdatedDate ()

Return type: String

setDeletedDate ($deleted_date)

Parameters:
$deleted_date (string) – Deleted Date
Return type: Object

getDeletedDate ()

Return type: String

setPaymethod ($paymethod)

Parameters:
$paymethod (string) – Paymethod
Return type: Object

getPaymethod ()

Return type: String

setPaymethodOrganizationId ($org_id)

Parameters:
$org_id (string) – Organization ID
Return type: Object

getPaymethodOrganizationId ()

Return type: String

setPaymethodLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getPaymethodLocationId ()

Return type: String

setPaymethodCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getPaymethodCustomerToken ()

Return type: String

setPaymethodToken ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

getPaymethodToken ()

Return type: String

setUpdatePaymethodToken ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

getUpdatePaymethodToken ()

Return type: String

setPaymethodLabel ($label)

Parameters:
$label (string) – Label
Return type: Object

getPaymethodLabel ()

Return type: String

setPaymethodCard ($card)

Parameters:
$card (string) – The Card Object
Return type: Object

getPaymethodCard ()

Return type: String

setPaymethodCardType ($card_type)

Parameters:
$card_type (string) – Card Type
Return type: Object

getPaymethodCardType ()

Return type: String

setPaymethodNameOnCard ($name_on_card)

Parameters:
$name_on_card (string) – Name On Card
Return type: Object

getPaymethodNameOnCard ()

Return type: String

setPaymethodAccountNumber ($account_number)

Parameters:
$account_number (string) – Account Number
Return type: Object

getPaymethodAccountNumber ()

Return type: String

setPaymethodExpireMonth ($expire_month)

Parameters:
$expire_month (string) – Expire Month
Return type: Object

getPaymethodExpireMonth ()

Return type: String

setPaymethodExpireYear ($expire_year)

Parameters:
$expire_year (string) – Expire Year
Return type: Object

getPaymethodExpireYear ()

Return type: String

setPaymethodCardVerficationValue ($card_verification_value)

Parameters:
$card_verification_value (string) – Card Verification Value
Return type: Object

getPaymethodCardVerficationValue ()

Return type: String

setPaymethodProcurementCard ($procurement_card)

Parameters:
$procurement_card (string) – Procurement Card
Return type: Object

getPaymethodProcurementCard ()

Return type: String

setPaymethodCustomerAccountingCode ($customer_accounting_code)

Parameters:
$customer_accounting_code (string) – Customer Accounting Code
Return type: Object

getPaymethodCustomerAccountingCode ()

Return type: String

setPaymethodOneTimeToken ($one_time_token)

Parameters:
$one_time_token (string) – One Time Token
Return type: Object

getPaymethodOneTimeToken ()

Return type: String

setPaymethodEcheck ($echeck)

Parameters:
$echeck (string) – Echeck
Return type: Object

getPaymethodEcheck ()

Return type: String

setEcheckAccountHolder ($account_holder)

Parameters:
$account_holder (string) – Account Holder
Return type: Object

getEcheckAccountHolder ()

Return type: String

setEcheckAccountNumber ($account_number)

Parameters:
$account_number (string) – Account Number
Return type: Object

getEcheckAccountNumber ()

Return type: String

setEcheckRoutingNumber ($routing_number)

Parameters:
$routing_number (string) – Routing Number
Return type: Object

getEcheckRoutingNumber ()

Return type: String

setEcheckAccountType ($account_type)

Parameters:
$account_type (string) – Account Type
Return type: Object

getEcheckAccountType ()

Return type: String

setEcheckSecCode ($sec_code)

Parameters:
$sec_code (string) – Sec Code
Return type: Object

getEcheckSecCode ()

Return type: String

setPaymethodNotes ($notes)

Parameters:
$notes (string) – Notes
Return type: Object

getPaymethodNotes ()

Return type: String

setAddresses ($addresses)

Parameters:
$addresses (array) – Addresses
Return type: Object

getAddresses ()

Return type: String

setAddressToken ($address_token)

Parameters:
$address_token (string) – Address Token
Return type: Object

getAddressToken ()

Return type: String

setAddressCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getAddressCustomerToken ()

Return type: String

setAddressOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getAddressOrganizationId ()

Return type: String

setAddressLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getAddressLocationId ()

Return type: String

setAddressFirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getAddressFirstName ()

Return type: String

setAddressLastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getAddressLastName ()

Return type: String

setAddressCompanyName ($company_name)

Parameters:
$company_name (string) – Company Name
Return type: Object

getAddressCompanyName ()

Return type: String

setAddressPhone ($phone)

Parameters:
$phone (string) – Phone
Return type: Object

getAddressPhone ()

Return type: String

setAddressEmail ($email)

Parameters:
$email (string) – Email
Return type: Object

getAddressEmail ()

Return type: String

setAddressLabel ($label)

Parameters:
$label (string) – Label
Return type: Object

getAddressLabel ()

Return type: String

setAddressType ($address_type)

Parameters:
$address_type (string) – Address Type
Return type: Object

getAddressType ()

Return type: String

setAddressTypeShipping ($shipping_address_type)

Parameters:
$shipping_address_type (string) – Shipping Address Type
Return type: Object

getAddressTypeShipping ()

Return type: String

setPhysicalAddress ($physical_address)

Parameters:
$physical_address (string) – Physical Address
Return type: Object

getPhysicalAddress ()

Return type: String

setPhysicalAddressStreeLine1 ($street_line1)

Parameters:
$street_line1 (string) – Street Line1
Return type: Object

getPhysicalAddressStreeLine1 ()

Return type: String

setPhysicalAddressStreeLine2 ($street_line2)

Parameters:
$street_line2 (string) – Street Line2
Return type: Object

getPhysicalAddressStreeLine2 ()

Return type: String

setPhysicalAddressLocality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getPhysicalAddressLocality ()

Return type: String

setPhysicalAddressRegion ($region)

Parameters:
$region (string) – Region
Return type: Object

getPhysicalAddressRegion ()

Return type: String

setPhysicalAddressPostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getPhysicalAddressPostalCode ()

Return type: String

create ()

Return type: Object

getCustomerOfOrganization ($org_id)

Parameters:
$org_id (string) [optional] – Organization ID
Return type: Object

getCustomerOfLocation ($org_id, $loc_id)

Parameters:
$org_id (string) [optional] – Organization ID $loc_id (string) [optional] – Location ID
Return type: Object

getCustomerById ($cst_token, $org_id, $loc_id)

Parameters:
$cst_token (string) – Customer Token $org_id (string) [optional] – Organization ID $loc_id (string) [optional] – Location ID
Return type: Object

getCustomersBySearchFilter ($filter_data, $org_id)

Parameters:
$filter_data (array) – An array contains "field" => "value" $org_id (string) [optional] – Organization ID
Return type: Object

update ($customer_token, $org_id, $loc_id)

Parameters:
$customer_token (string) – Customer Token $org_id (string) [optional] – Organization ID $loc_id (string) [optional] – Location ID
Return type: Object

updateAltURI ($customer_token, $org_id)

Parameters:
$customer_token (string) – Customer Token $org_id (string) [optional] – Organization ID
Return type: Object

updateWithPaymethod ($customer_token, $org_id, $loc_id)

Parameters:
$customer_token (string) – Customer Token $org_id (string) [optional] – Organization ID $loc_id (string) [optional] – Location ID
Return type: Object

delete ($customer_token, $org_id, $loc_id)

Parameters:
$customer_token (string) – Customer Token $org_id (string) [optional] – Organization ID $loc_id (string) [optional] – Location ID
Return type: Object

Disputes()

The following functions are available:

getDisputesByOrganization ($org_id)

Parameters:
$org_id (string) [optional] – Organization Id
Return type: Object

getDisputesBySearchFilter ($filter_data, $org_id)

Parameters:
$filter_data (array) – An array contains "field" => "value" $org_id (string) [optional] – Organization Id
Return type: Object

getDisputesByID ($dsp_id, $org_id)

Parameters:
$dsp_id (string) – Disputes Id $org_id (string) [optional] – Organization Id
Return type: Object

Fundings()

The following functions are available:

getFundingsByOrganization ($org_id)

Parameters:
$org_id (string) [optional] – Organization ID
Return type: Object

getFundingsByDateRange ($start_date, $end_date, $org_id)

Parameters:
$start_date (string) – Start Date $end_date (string) – End Date $org_id (string) [optional] – Organization ID
Return type: Object

getFundingsByID ($fund_id, $org_id)

Parameters:
$fund_id (string) – Funding ID $org_id (string) [optional] – Organization ID
Return type: Object

getTransactionsOfFunding ($fund_id, $org_id)

Parameters:
$fund_id (string) – Funding ID $org_id (string) [optional] – Organization ID
Return type: Object

getSettlementsOfFunding ($fund_id, $org_id)

Parameters:
$fund_id (string) – Funding Id $org_id (string) [optional] – Organization Id
Return type: Object

Location()

The following functions are available:

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setStatus ($status)

Parameters:
$status (string) – Status
Return type: Object

getStatus ()

Return type: String

setCreatedDate ($created_date)

Parameters:
$created_date (string) – Created Date
Return type: Object

getCreatedDate ()

Return type: String

setDBAName ($dba_name)

Parameters:
$dba_name (string) – The merchant's Doing Business As (DBA) name.
Return type: Object

getDBAName ()

Return type: String

setStreetAddress1 ($street_address1)

Parameters:
$street_address1 (string) – Street Address1
Return type: Object

getStreetAddress1 ()

Return type: String

setStreetAddress2 ($street_address2)

Parameters:
$street_address2 (string) – Street Address2
Return type: Object

getStreetAddress2 ()

Return type: String

setLocality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getLocality ()

Return type: String

setRegion ($region)

Parameters:
$region (string) – Region
Return type: Object

getRegion ()

Return type: String

setPostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getPostalCode ()

Return type: String

setCountry ($country)

Parameters:
$country (string) – Country
Return type: Object

getCountry ()

Return type: String

setBusinessPhone ($business_phone)

Parameters:
$business_phone (string) – Business Phone
Return type: Object

getBusinessPhone ()

Return type: String

setCurrency ($currency)

Parameters:
$currency (string) – Currency
Return type: Object

getCurrency ()

Return type: String

setTimeZone ($timezone)

Parameters:
$timezone (string) – Timezone
Return type: Object

getTimeZone ()

Return type: String

setBusinessType ($business_type)

Parameters:
$business_type (string) – Business Type
Return type: Object

getBusinessType ()

Return type: String

setOrganizationID ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationID ()

Return type: String

setOrganizationName ($organization_name)

Parameters:
$organization_name (string) – Organization Name
Return type: Object

getOrganizationName ()

Return type: String

setParentOrganizationID ($parent_organization_id)

Parameters:
$parent_organization_id (string) – Parent Organization Id
Return type: Object

getParentOrganizationID ()

Return type: String

setContactFullName ($full_name)

Parameters:
$full_name (string) – Full Name
Return type: Object

getContactFullName ()

Return type: String

setContactPhone ($phone)

Parameters:
$phone (string) – Phone
Return type: Object

getContactPhone ()

Return type: String

setContactEmail ($email)

Parameters:
$email (string) – Email
Return type: Object

getContactEmail ()

Return type: String

setContactType ($type)

Parameters:
$type (string) – Contact Type
Return type: Object

getContactType ()

Return type: String

setEcheckServiceFeePercentage ($service_fee_percentage)

Parameters:
$service_fee_percentage (string) – Service Fee Percentage
Return type: Object

getEcheckServiceFeePercentage ()

Return type: String

setEcheckServiceFeeMinAmount ($service_fee_min_amount)

Parameters:
$service_fee_min_amount (string) – Service Fee Min Amount
Return type: Object

getEcheckServiceFeeMinAmount ()

Return type: String

setEcheckServiceFeeAmount ($service_fee_amount)

Parameters:
$service_fee_amount (string) – Service Fee Amount
Return type: Object

getEcheckServiceFeeAmount ()

Return type: String

setEcheckServiceFeeRange ($service_fee_range)

Parameters:
$service_fee_range (string) – Service Fee Range
Return type: Object

getEcheckServiceFeeRange ()

Return type: String

setEcheckServiceFeeTiered ($service_fee_tiered)

Parameters:
$service_fee_tiered (string) – Service Fee Tiered
Return type: Object

getEcheckServiceFeeTiered ()

Return type: String

setEcheckServiceFeeAdditionalAmount ($service_fee_additional_amount)

Parameters:
$service_fee_additional_amount (string) – Service Fee Additional Amount
Return type: Object

getEcheckServiceFeeAdditionalAmount ()

Return type: String

setEcheckHoldDaysSales ($hold_days_sales)

Parameters:
$hold_days_sales (string) – Hold Days Sales
Return type: Object

getEcheckHoldDaysSales ()

Return type: String

setEcheckHoldDaysRefunds ($hold_days_refunds)

Parameters:
$hold_days_refunds (string) – Hold Days Refunds
Return type: Object

getEcheckHoldDaysRefunds ()

Return type: String

setEcheckHoldDaysResubmits ($hold_days_resubmits)

Parameters:
$hold_days_resubmits (string) – Hold Days Resubmits
Return type: Object

getEcheckHoldDaysResubmits ()

Return type: String

setEcheckCutOffTime ($cut_off_time)

Parameters:
$cut_off_time (string) – Cut Off Time
Return type: Object

getEcheckCutOffTime ()

Return type: String

setEcheckEntryClassCode ($entry_class_code)

Parameters:
$entry_class_code (string) – Entry Class Code
Return type: Object

getEcheckEntryClassCode ()

Return type: String

setEcheckNachaID ($nacha_id)

Parameters:
$nacha_id (string) – Nacha Id
Return type: Object

getEcheckNachaID ()

Return type: String

setCardCutOffTime ($cut_off_time)

Parameters:
$cut_off_time (string) – Cut Off Time
Return type: Object

getCardCutOffTime ()

Return type: String

setCardMarketType ($market_type)

Parameters:
$market_type (string) – Market Type
Return type: Object

getCardMarketType ()

Return type: String

setCardServiceFeePercentage ($service_fee_percentage)

Parameters:
$service_fee_percentage (string) – Service Fee Percentage
Return type: Object

getCardServiceFeePercentage ()

Return type: String

setCardServiceFeeMinAmount ($service_fee_min_amount)

Parameters:
$service_fee_min_amount (string) – Service Fee Min Amount
Return type: Object

getCardServiceFeeMinAmount ()

Return type: String

setCardServiceFeeAmount ($service_fee_amount)

Parameters:
$service_fee_amount (string) – Service Fee Amount
Return type: Object

getCardServiceFeeAmount ()

Return type: String

setCardServiceFeeRange ($service_fee_range)

Parameters:
$service_fee_range (string) – Service Fee Range
Return type: Object

getCardServiceFeeRange ()

Return type: String

setCardServiceFeeTiered ($service_fee_tiered)

Parameters:
$service_fee_tiered (string) – Service Fee Tiered
Return type: Object

getCardServiceFeeTiered ()

Return type: String

setCardServiceFeeAdditionalAmount ($service_fee_additional_amount)

Parameters:
$service_fee_additional_amount (string) – Service Fee Additional Amount
Return type: Object

getCardServiceFeeAdditionalAmount ()

Return type: String

setCardServiceFeeVisaTaxAmount ($service_fee_visa_tax_amount)

Parameters:
$service_fee_visa_tax_amount (string) – Service Fee Visa Tax Amount
Return type: Object

getCardServiceFeeVisaTaxAmount ()

Return type: String

setCardType ($card_types)

Parameters:
$card_types (string) – Card Types
Return type: Object

getCardType ()

Return type: String

setCardAccountUpdater ($account_updater)

Parameters:
$account_updater (string) – Account Updater
Return type: Object

getCardAccountUpdater ()

Return type: String

setCardGateway ($gateway)

Parameters:
$gateway (string) – Gateway
Return type: Object

getCardGateway ()

Return type: String

setCardPlatform ($platform)

Parameters:
$platform (string) – Platform
Return type: Object

getCardPlatform ()

Return type: String

setCardBIN ($bin)

Parameters:
$bin (string) – BIN
Return type: Object

getCardBIN ()

Return type: String

setCardTID ($tid)

Parameters:
$tid (string) – TID
Return type: Object

getCardTID ()

Return type: String

setCardDailyDebit ($daily_debit)

Parameters:
$daily_debit (string) – Daily Debit
Return type: Object

getCardDailyDebit ()

Return type: String

setCardDailyCredit ($daily_credit)

Parameters:
$daily_credit (string) – Daily Credit
Return type: Object

getCardDailyCredit ()

Return type: String

setCardMonthlyDebit ($monthly_debit)

Parameters:
$monthly_debit (string) – Monthly Debit
Return type: Object

getCardMonthlyDebit ()

Return type: String

setCardMonthlyCredit ($monthly_credit)

Parameters:
$monthly_credit (string) – Monthly Credit
Return type: Object

getCardMonthlyCredit ()

Return type: String

setCardPerTransactionDebit ($per_trans_debit)

Parameters:
$per_trans_debit (string) – Per Transaction Debit
Return type: Object

getCardPerTransactionDebit ()

Return type: String

setCardPerTransactionCredit ($per_trans_credit)

Parameters:
$per_trans_credit (string) – Per Transaction Credit
Return type: Object

getCardPerTransactionCredit ()

Return type: String

setEcheckDailyDebit ($daily_debit)

Parameters:
$daily_debit (string) – Daily Debit
Return type: Object

getEcheckDailyDebit ()

Return type: String

setEcheckDailyCredit ($daily_credit)

Parameters:
$daily_credit (string) – Daily Credit
Return type: Object

getEcheckDailyCredit ()

Return type: String

setEcheckMonthlyDebit ($monthly_debit)

Parameters:
$monthly_debit (string) – Monthly Debit
Return type: Object

getEcheckMonthlyDebit ()

Return type: String

setecheckMonthlyCredit ($monthly_credit)

Parameters:
$monthly_credit (string) – Monthly Credit
Return type: Object

getEcheckMonthlyCredit ()

Return type: String

setEcheckPerTransactionDebit ($per_trans_debit)

Parameters:
$per_trans_debit (string) – Per Transaction Debit
Return type: Object

getEcheckPerTransactionDebit ()

Return type: String

setEcheckPerTransactionCredit ($per_trans_credit)

Parameters:
$per_trans_credit (string) – Per Transaction Credit
Return type: Object

getEcheckPerTransactionCredit ()

Return type: String

setBankAccountCreditToken ($bankaccount_credits_token)

Parameters:
$bankaccount_credits_token (string) – Bank Account Credits Token
Return type: Object

getBankAccountCreditToken ()

Return type: String

setBankAccountDebitToken ($bankaccount_debits_token)

Parameters:
$bankaccount_debits_token (string) – Bank Account Debits Token
Return type: Object

getBankAccountDebitToken ()

Return type: String

setBankAccountBillingToken ($bankaccount_billing_token)

Parameters:
$bankaccount_billing_token (string) – Bank Account Billing Token
Return type: Object

getBankAccountBillingToken ()

Return type: String

setBankAccountCcfeeToken ($bankaccount_ccfee_token)

Parameters:
$bankaccount_ccfee_token (string) – Bank Account CC fee Token
Return type: Object

getBankAccountCcfeeToken ()

Return type: String

setBankAccountEcfeeToken ($bankaccount_ecfee_token)

Parameters:
$bankaccount_ecfee_token (string) – Bank Account EC fee Token
Return type: Object

getBankAccountEcfeeToken ()

Return type: String

getLocations ($org_id)

Parameters:
$org_id (string) [optional] – Organization ID
Return type: Object

getLocationById ($loc_id, $org_id)

Parameters:
$loc_id (string) [optional] – Location ID $org_id (string) [optional] – Organization ID
Return type: Object

assignBankAccount ($loc_id)

Parameters:
$loc_id (string) [optional] – Location ID
Return type: Object

changeProcessingLimits ($org_id, $loc_id)

Parameters:
$org_id (string) [optional] – Organization ID $loc_id (string) [optional] – Location ID
Return type: Object

updateLocationAddress ($org_id, $loc_id)

Parameters:
$org_id (string) [optional] – Organization ID $loc_id (string) [optional] – Location ID
Return type: Object

Paymethod()

The following functions are available:

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getCustomerToken ()

Return type: String

setLabel ($label)

Parameters:
$label (string) – Label
Return type: Object

getLabel ()

Return type: String

setCustomerId ($customer_id)

Parameters:
$customer_id (string) – Customer Id
Return type: Object

getCustomerId ()

Return type: String

setIsDefault ($is_default)

Parameters:
$is_default (string) – Is Default
Return type: Object

getIsDefault ()

Return type: String

setBillingAddressToken ($billing_address_token)

Parameters:
$billing_address_token (string) – Billing Address Token
Return type: Object

getBillingAddressToken ()

Return type: String

setNotes ($notes)

Parameters:
$notes (string) – Notes
Return type: Object

getNotes ()

Return type: String

setCardType ($card_type)

Parameters:
$card_type (string) – Card Type
Return type: Object

getCardType ()

Return type: String

setNameOnCard ($name_on_card)

Parameters:
$name_on_card (string) – Name On Card
Return type: Object

getNameOnCard ()

Return type: String

setCardLast4AccountNumber ($last_4_account_number)

Parameters:
$last_4_account_number (string) – Last 4 Digit of the Account Number
Return type: Object

getCardLast4AccountNumber ()

Return type: String

setCardAccountNumber ($account_number)

Parameters:
$account_number (string) – Account Number
Return type: Object

getCardAccountNumber ()

Return type: String

setExpireMonth ($expire_month)

Parameters:
$expire_month (string) – Expire Month
Return type: Object

getExpireMonth ()

Return type: String

setExpireYear ($expire_year)

Parameters:
$expire_year (string) – Expire Year
Return type: Object

getExpireYear ()

Return type: String

setCardVerificationValue ($card_verification_value)

Parameters:
$card_verification_value (string) – Card Verification Value
Return type: Object

getCardVerificationValue ()

Return type: String

setProcurementCard ($procurement_card)

Parameters:
$procurement_card (string) – Procurement Card
Return type: Object

getProcurementCard ()

Return type: String

setCardOneTimeToken ($one_time_token)

Parameters:
$one_time_token (string) – One Time Token
Return type: Object

getCardOneTimeToken ()

Return type: String

setCustomerAccountingCode ($customer_accounting_code)

Parameters:
$customer_accounting_code (string) – Customer Accounting Code
Return type: Object

getCustomerAccountingCode ()

Return type: String

setAuCode ($au_code)

Parameters:
$au_code (string) – Account Updater Code
Return type: Object

getAuCode ()

Return type: String

setSuppressAccountUpdater ($suppress_account_updater)

Parameters:
$suppress_account_updater (string) – Suppress Account Updater
Return type: Object

getSuppressAccountUpdater ()

Return type: String

setAuUpdateDate ($au_updated_date)

Parameters:
$au_updated_date (string) – Account Updater Updated Date
Return type: Object

getAuUpdateDate ()

Return type: String

setAuDescription ($au_description)

Parameters:
$au_description (string) – Account Updater Description
Return type: Object

getAuDescription ()

Return type: String

setAccountHolder ($account_holder)

Parameters:
$account_holder (string) – Account Holder
Return type: Object

getAccountHolder ()

Return type: String

setEcheckLast4AccountNumber ($last_4_account_number)

Parameters:
$last_4_account_number (string) – Last 4 Digit of the Account Number
Return type: Object

getEcheckLast4AccountNumber ()

Return type: String

setAccountNumber ($account_number)

Parameters:
$account_number (string) – Account Number
Return type: Object

getAccountNumber ()

Return type: String

setRoutingNumber ($routing_number)

Parameters:
$routing_number (string) – Routing Number
Return type: Object

getRoutingNumber ()

Return type: String

setAccountType ($account_type)

Parameters:
$account_type (string) – Account Type
Return type: Object

getAccountType ()

Return type: String

setSecCode ($sec_code)

Parameters:
$sec_code (string) – standard-entry class code
Return type: Object

getSecCode ()

Return type: String

setEcheckOneTimeToken ($one_time_token)

Parameters:
$one_time_token (string) – One Time Token
Return type: Object

getEcheckOneTimeToken ()

Return type: String

setItemDescription ($item_description)

Parameters:
$item_description (string) – Item Description
Return type: Object

getItemDescription ()

Return type: String

getPaymethodToken ()

Return type: String

create ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

update ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

delete ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

createLocationlessPaymethod ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getPaymethodByCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getPaymethodById ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

getPaymethodOfaLocation ()

Return type: String

getPaymethodOfAnOrganization ()

Return type: String

getAccountUpdaterTokenUpdates ($start_date, $end_date)

Parameters:
$start_date (string) – Start Date $end_date (string) – End Date
Return type: Object

Scheduleitems()

The following functions are available:

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setScheduleItemId ($schedule_item_id)

Parameters:
$schedule_item_id (string) – Schedule Item Id
Return type: Object

getScheduleItemId ()

Return type: String

setCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getCustomerToken ()

Return type: String

setPaymethodToken ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

getPaymethodToken ()

Return type: String

setTransactionId ($transaction_id)

Parameters:
$transaction_id (string) – Transaction Id
Return type: Object

getTransactionId ()

Return type: String

setScheduleId ($schedule_id)

Parameters:
$schedule_id (string) – Schedule Id
Return type: Object

getScheduleId ()

Return type: String

setScheduleItemAmount ($schedule_item_amount)

Parameters:
$schedule_item_amount (string) – Schedule Item Amount
Return type: Object

getScheduleItemAmount ()

Return type: String

setScheduleItemServiceFeeAmount ($schedule_item_service_fee_amount)

Parameters:
$schedule_item_service_fee_amount (string) – Schedule Item Service Fee Amount
Return type: Object

getScheduleItemServiceFeeAmount ()

Return type: String

setScheduleItemAuthorizationAmount ($schedule_item_authorization_amount)

Parameters:
$schedule_item_authorization_amount (string) – Schedule Item Authorization Amount
Return type: Object

getScheduleItemAuthorizationAmount ()

Return type: String

setScheduleItemStatus ($schedule_item_status)

Parameters:
$schedule_item_status (string) – Schedule Item Status
Return type: Object

getScheduleItemStatus ()

Return type: String

setScheduleItemDate ($schedule_item_date)

Parameters:
$schedule_item_date (string) – Schedule Item Date
Return type: Object

getScheduleItemDate ()

Return type: String

setScheduleItemProcessDate ($schedule_item_processed_date)

Parameters:
$schedule_item_processed_date (string) – Schedule Item Processed Date
Return type: Object

getScheduleItemProcessDate ()

Return type: String

setScheduleItemCreatedDate ($schedule_item_created_date)

Parameters:
$schedule_item_created_date (string) – Schedule Item Created Date
Return type: Object

getScheduleItemCreatedDate ()

Return type: String

setScheduleItemDescription ($schedule_item_description)

Parameters:
$schedule_item_description (string) – Schedule Item Description
Return type: Object

getScheduleItemDescription ()

Return type: String

create ()

Return type: Object

update ($scheduleitems_id)

Parameters:
$scheduleitems_id (string) – Schedule Item Id
Return type: Object

delete ($scheduleitems_id)

Parameters:
$scheduleitems_id (string) – Schedule Item Id
Return type: Object

getScheduleItemsById ($scheduleitems_id)

Parameters:
$scheduleitems_id (string) – Schedule Item Id
Return type: Object

getScheduleItemsOfaLocation ()

Return type: Object

getScheduleItemsOfAnOrganization ()

Return type: Object

getScheduleItemsForaCustomer ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getScheduleItemsForaPaymethod ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

Schedules()

The following functions are available:

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setScheduleItemId ($schedule_item_id)

Parameters:
$schedule_item_id (string) – Schedule Item Id
Return type: Object

getScheduleItemId ()

Return type: String

setCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getCustomerToken ()

Return type: String

setPaymethodToken ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

getPaymethodToken ()

Return type: String

setScheduleId ($schedule_id)

Parameters:
$schedule_id (string) – Schedule Id
Return type: Object

getScheduleId ()

Return type: String

setAction ($action)

Parameters:
$action (string) – Action
Return type: Object

getAction ()

Return type: String

setScheduleQuantity ($schedule_quantity)

Parameters:
$schedule_quantity (string) – Schedule Quantity
Return type: Object

getScheduleQuantity ()

Return type: String

setScheduleFrequency ($schedule_frequency)

Parameters:
$schedule_frequency (string) – Schedule Frequency
Return type: Object

getScheduleFrequency ()

Return type: String

setScheduleAmount ($schedule_amount)

Parameters:
$schedule_amount (string) – Schedule Amount
Return type: Object

getScheduleAmount ()

Return type: String

setScheduleServiceFeeAmount ($schedule_service_fee_amount)

Parameters:
$schedule_service_fee_amount (string) – Schedule Service Fee Amount
Return type: Object

getScheduleServiceFeeAmount ()

Return type: String

setScheduleAuthorizationAmount ($schedule_authorization_amount)

Parameters:
$schedule_authorization_amount (string) – Schedule Authorization Amount
Return type: Object

getScheduleAuthorizationAmount ()

Return type: String

setScheduleStartDate ($schedule_start_date)

Parameters:
$schedule_start_date (string) – Schedule Start Date
Return type: Object

getScheduleStartDate ()

Return type: String

setScheduleCreatedDate ($schedule_created_date)

Parameters:
$schedule_created_date (string) – Schedule Created Date
Return type: Object

getScheduleCreatedDate ()

Return type: String

setCustomerAcctCode ($customer_acct_code)

Parameters:
$customer_acct_code (string) – Customer Accounting Code
Return type: Object

getCustomerAcctCode ()

Return type: String

setSecCode ($sec_code)

Parameters:
$sec_code (string) – Standard Entry Class code
Return type: Object

getSecCode ()

Return type: String

setScheduleStatus ($schedule_status)

Parameters:
$schedule_status (string) – Schedule Status
Return type: Object

getScheduleStatus ()

Return type: String

setItemDescription ($item_description)

Parameters:
$item_description (string) – Item Description
Return type: Object

getItemDescription ()

Return type: String

setReferenceId ($reference_id)

Parameters:
$reference_id (string) – Reference Id
Return type: Object

getReferenceId ()

Return type: String

setOrderNumber ($order_number)

Parameters:
$order_number (string) – Order Number
Return type: Object

getOrderNumber ()

Return type: String

setCustomerId ($customer_id)

Parameters:
$customer_id (string) – Customer Id
Return type: Object

getCustomerId ()

Return type: String

setScheduleNextMonth ($schedule_next_amount)

Parameters:
$schedule_next_amount (string) – Schedule Next Amount
Return type: Object

getScheduleNextMonth ()

Return type: String

setScheduleNextDate ($schedule_next_date)

Parameters:
$schedule_next_date (string) – Schedule Next Date
Return type: Object

getScheduleNextDate ()

Return type: String

setScheduleLastAmount ($schedule_last_amount)

Parameters:
$schedule_last_amount (string) – Schedule Last Amount
Return type: Object

getScheduleLastAmount ()

Return type: String

setScheduleLastDate ($schedule_last_date)

Parameters:
$schedule_last_date (string) – Schedule Last Date
Return type: Object

getScheduleLastDate ()

Return type: String

setScheduleSuccessfulAmount ($schedule_successful_amount)

Parameters:
$schedule_successful_amount (string) – Schedule Successful Amount
Return type: Object

getScheduleSuccessfulAmount ()

Return type: String

setScheduleSuccessfulAuthorizationAmount ($schedule_successful_authorization_amount)

Parameters:
$schedule_successful_authorization_amount (string) – Schedule Successful Authorization Amount
Return type: Object

getScheduleSuccessfulAuthorizationAmount ()

Return type: String

setScheduleSuccessfulQuantity ($schedule_successful_quantity)

Parameters:
$schedule_successful_quantity (string) – Schedule Successful Quantity
Return type: Object

getScheduleSuccessfulQuantity ()

Return type: String

setScheduleFailedAmount ($schedule_failed_amount)

Parameters:
$schedule_failed_amount (string) – Schedule Failed Amount
Return type: Object

getScheduleFailedAmount ()

Return type: String

setScheduleFailedQuantity ($schedule_failed_quantity)

Parameters:
$schedule_failed_quantity (string) – Schedule Failed Quantity
Return type: Object

getScheduleFailedQuantity ()

Return type: String

setScheduleRemainingAmount ($scheduled_remaining_amount)

Parameters:
$scheduled_remaining_amount (string) – Scheduled Remaining Amount
Return type: Object

getScheduleRemainingAmount ()

Return type: String

setScheduleRemainingQuantity ($scheduled_remaining_quantity)

Parameters:
$scheduled_remaining_quantity (string) – Scheduled Remaining Quantity
Return type: Object

getScheduleRemainingQuantity ()

Return type: String

setScheduleSuspendedAmount ($scheduled_suspended_amount)

Parameters:
$scheduled_suspended_amount (string) – Scheduled Suspended Amount
Return type: Object

getScheduleSuspendedAmount ()

Return type: String

setScheduleSuspendedQuantity ($scheduled_suspended_quantity)

Parameters:
$scheduled_suspended_quantity (string) – Scheduled Suspended Quantity
Return type: Object

getScheduleSuspendedQuantity ()

Return type: String

setXdata ($xdata)

Parameters:
$xdata (Object) – Extra Data
Return type: Object

getXdata ()

Return type: Object

create ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

update ($schedule_id)

Parameters:
$schedule_id (string) – Schedule Id
Return type: Object

delete ($schedule_id)

Parameters:
$schedule_id (string) – Schedule Id
Return type: Object

getSchedulesForALocation ()

Return type: Object

getSchedulesForACustomer ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getScheduleById ($schedule_id)

Parameters:
$schedule_id (string) – Schedule Id
Return type: Object

Settlements()

The following functions are available:

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setFundingId ($funding_id)

Parameters:
$funding_id (string) – Funding Id
Return type: Object

getFundingId ()

Return type: String

setCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getCustomerToken ()

Return type: String

setCustomerId ($customer_id)

Parameters:
$customer_id (string) – Customer Id
Return type: Object

getCustomerId ()

Return type: String

setOrderNumber ($order_number)

Parameters:
$order_number (string) – Order Number
Return type: Object

getOrderNumber ()

Return type: String

setReferenceId ($reference_id)

Parameters:
$reference_id (string) – Reference Id
Return type: Object

getReferenceId ()

Return type: String

setSettleId ($settle_id)

Parameters:
$settle_id (string) – Settle Id
Return type: Object

getSettleId ()

Return type: String

setTransactionId ($transaction_id)

Parameters:
$transaction_id (string) – Transaction Id
Return type: Object

getTransactionId ()

Return type: String

setSettleBatchId ($settle_batch_id)

Parameters:
$settle_batch_id (string) – Settle Batch Id
Return type: Object

getSettleBatchId ()

Return type: String

setSettleDate ($settle_date)

Parameters:
$settle_date (string) – Settle Date
Return type: Object

getSettleDate ()

Return type: String

setSettleType ($settle_type)

Parameters:
$settle_type (string) – Settle Type
Return type: Object

getSettleType ()

Return type: String

setResponseCode ($settle_response_code)

Parameters:
$settle_response_code (string) – Settle Response Code
Return type: Object

getResponseCode ()

Return type: String

setSettleAmount ($settle_amount)

Parameters:
$settle_amount (string) – Settle Amount
Return type: Object

getSettleAmount ()

Return type: String

setMethod ($method)

Parameters:
$method (string) – Method
Return type: Object

getMethod ()

Return type: String

getSettlements ()

Return type: Object

getSettlementsByTransactionId ($transaction_id)

Parameters:
$transaction_id (string) – Transaction Id
Return type: Object

getScheduleItemsOfAnOrganization ()

Return type: Object

getSettlementsByDate ($start_date, $end_date)

Parameters:
$start_date (string) – Start Date $end_date (string) – End Date
Return type: Object

getScheduleItemsForaPaymethod ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

Transactions()

The following functions are available:

setOrganizationId ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getOrganizationId ()

Return type: String

setLocationId ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getLocationId ()

Return type: String

setAction ($action)

Parameters:
$action (string) – Action
Return type: Object

getAction ()

Return type: String

setStatus ($status)

Parameters:
$status (string) – Status
Return type: Object

getStatus ()

Return type: String

setCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getCustomerToken ()

Return type: String

setCustomerId ($customer_id)

Parameters:
$customer_id (string) – Customer Id
Return type: Object

getCustomerId ()

Return type: String

setPaymethodToken ($paymethod_token)

Parameters:
$paymethod_token (string) – Paymethod Token
Return type: Object

getPaymethodToken ()

Return type: String

setReferenceId ($reference_id)

Parameters:
$reference_id (string) – Reference Id
Return type: Object

getReferenceId ()

Return type: String

setAuthorizationAmount ($authorization_amount)

Parameters:
$authorization_amount (string) – Authorization Amount
Return type: Object

getAuthorizationAmount ()

Return type: String

setOrderNumber ($order_number)

Parameters:
$order_number (string) – Order Number
Return type: Object

getOrderNumber ()

Return type: String

setOriginalTransactionID ($original_transaction_id)

Parameters:
$original_transaction_id (string) – Original Transaction Id
Return type: Object

getOriginalTransactionID ()

Return type: String

setTransactionId ($transaction_id)

Parameters:
$transaction_id (string) – Transaction Id
Return type: Object

getTransactionId ()

Return type: String

setAuthorizationCode ($authorization_code)

Parameters:
$authorization_code (string) – Authorization Code
Return type: Object

getAuthorizationCode ()

Return type: String

setEnteredBy ($entered_by)

Parameters:
$entered_by (string) – Entered By
Return type: Object

getEnteredBy ()

Return type: String

setRecievedDate ($received_date)

Parameters:
$received_date (string) – Received Date
Return type: Object

getRecievedDate ()

Return type: String

setOriginalDate ($origination_date)

Parameters:
$origination_date (string) – Origination Date
Return type: Object

getOriginalDate ()

Return type: String

setSalesTaxAmount ($sales_tax_amount)

Parameters:
$sales_tax_amount (string) – Sales Tax Amount
Return type: Object

getSalesTaxAmount ()

Return type: String

setSubtotalAmount ($subtotal_amount)

Parameters:
$subtotal_amount (string) – Subtotal Amount
Return type: Object

getSubtotalAmount ()

Return type: String

setServiceFeeAmount ($service_fee_amount)

Parameters:
$service_fee_amount (string) – Service Fee Amount
Return type: Object

getServiceFeeAmount ()

Return type: String

setRecurringIndicator ($recurring_indicator)

Parameters:
$recurring_indicator (string) – Recurring Indicator
Return type: Object

getRecurringIndicator ()

Return type: String

setCustomerIPAddress ($customer_ip_address)

Parameters:
$customer_ip_address (string) – Customer IP Address
Return type: Object

getCustomerIPAddress ()

Return type: String

setSaveToken ($save_token)

Parameters:
$save_token (string) – Save Token
Return type: Object

getSaveToken ()

Return type: String

setAttemptNumber ($attempt_number)

Parameters:
$attempt_number (string) – Attempt Number
Return type: Object

getAttemptNumber ()

Return type: String

setCOFTransactionType ($cof_transaction_type)

Parameters:
$cof_transaction_type (string) – Credential on file (COF) transaction Type
Return type: Object

getCOFTransactionType ()

Return type: String

setCOFInitialTransactionID ($cof_initial_transaction_id)

Parameters:
$cof_initial_transaction_id (string) – Credential on file (COF) Initial Transaction Id
Return type: Object

getCOFInitialTransactionID ()

Return type: String

setBillingAddressToken ($address_token)

Parameters:
$address_token (string) – Address Token
Return type: Object

getBillingAddressToken ()

Return type: String

setBillingAddressCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getBillingAddressCustomerToken ()

Return type: String

setBillingAddressOrganizationID ($organization_id)

Parameters:
$organization_id (string) – Organization Id
Return type: Object

getBillingAddressOrganizationID ()

Return type: String

setBillingAddressLocationID ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getBillingAddressLocationID ()

Return type: String

setBillingAddressFirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getBillingAddressFirstName ()

Return type: String

setBillingAddressLastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getBillingAddressLastName ()

Return type: String

setBillingAddressCompanyName ($company_name)

Parameters:
$company_name (string) – Company Name
Return type: Object

getBillingAddressCompanyName ()

Return type: String

setBillingAddressPhone ($phone)

Parameters:
$phone (string) – Phone
Return type: Object

getBillingAddressPhone ()

Return type: String

setBillingAddressEmail ($email)

Parameters:
$email (string) – Email
Return type: Object

getBillingAddressEmail ()

Return type: String

setBillingAddressLabel ($label)

Parameters:
$label (string) – Label
Return type: Object

getBillingAddressLabel ()

Return type: String

setBillingAddressType ($address_type)

Parameters:
$address_type (string) – Address Type
Return type: Object

getBillingAddressType ()

Return type: String

setBillingAddressShippingAddressType ($shipping_address_type)

Parameters:
$shipping_address_type (string) – Shipping Address Type
Return type: Object

getBillingAddressShippingAddressType ()

Return type: String

setBillingAddressStreetLine1 ($street_line1)

Parameters:
$street_line1 (string) – Street Line1
Return type: Object

getBillingAddressStreetLine1 ()

Return type: String

setBillingAddressStreetLine2 ($street_line2)

Parameters:
$street_line2 (string) – Street Line2
Return type: Object

getBillingAddressStreetLine2 ()

Return type: String

setBillingAddressLocality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getBillingAddressLocality ()

Return type: String

setBillingAddressRegion ($region)

Parameters:
$region (string) – Region
Return type: Object

getBillingAddressRegion ()

Return type: String

setBillingAddressCountry ($country)

Parameters:
$country (string) – Country
Return type: Object

getBillingAddressCountry ()

Return type: String

setBillingAddressPostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getBillingAddressPostalCode ()

Return type: String

setShippingAddressToken ($address_token)

Parameters:
$address_token (string) – Address Token
Return type: Object

getShippingAddressToken ()

Return type: String

setShippingAddressCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getShippingAddressCustomerToken ()

Return type: String

getShippingAddressOrganizationID ()

Return type: String

setShippingAddressLocationID ($location_id)

Parameters:
$location_id (string) – Location Id
Return type: Object

getShippingAddressLocationID ()

Return type: String

setShippingAddressFirstName ($first_name)

Parameters:
$first_name (string) – First Name
Return type: Object

getShippingAddressFirstName ()

Return type: String

setShippingAddressLastName ($last_name)

Parameters:
$last_name (string) – Last Name
Return type: Object

getShippingAddressLastName ()

Return type: String

setShippingAddressCompanyName ($company_name)

Parameters:
$company_name (string) – Company Name
Return type: Object

getShippingAddressCompanyName ()

Return type: String

setShippingAddressPhone ($phone)

Parameters:
$phone (string) – Phone
Return type: Object

getShippingAddressPhone ()

Return type: String

setShippingAddressEmail ($email)

Parameters:
$email (string) – Email
Return type: Object

getShippingAddressEmail ()

Return type: String

setShippingAddressLabel ($label)

Parameters:
$label (string) – Label
Return type: Object

getShippingAddressLabel ()

Return type: String

setShippingAddressType ($address_type)

Parameters:
$address_type (string) – Address Type
Return type: Object

getShippingAddressType ()

Return type: String

setShippingAddressShippingAddressType ($shipping_address_type)

Parameters:
$shipping_address_type (string) – Shipping Address Type
Return type: Object

getShippingAddressShippingAddressType ()

Return type: String

setShippingAddressStreetLine1 ($street_line1)

Parameters:
$street_line1 (string) – Street Line1
Return type: Object

getShippingAddressStreetLine1 ()

Return type: String

setShippingAddressStreetLine2 ($street_line2)

Parameters:
$street_line2 (string) – Street Line2
Return type: Object

getShippingAddressStreetLine2 ()

Return type: String

setShippingAddressLocality ($locality)

Parameters:
$locality (string) – Locality
Return type: Object

getShippingAddressLocality ()

Return type: String

setShippingAddressRegion ($region)

Parameters:
$region (string) – Region
Return type: Object

getShippingAddressRegion ()

Return type: String

setShippingAddressCountry ($country)

Parameters:
$country (string) – Country
Return type: Object

getShippingAddressCountry ()

Return type: String

setShippingAddressPostalCode ($postal_code)

Parameters:
$postal_code (string) – Postal Code
Return type: Object

getShippingAddressPostalCode ()

Return type: String

setCardType ($card_type)

Parameters:
$card_type (string) – Card Type
Return type: Object

getCardType ()

Return type: String

setNameOnCard ($name_on_card)

Parameters:
$name_on_card (string) – Name On Card
Return type: Object

getNameOnCard ()

Return type: String

setCardLast4AccountNumber ($last_4_account_number)

Parameters:
$last_4_account_number (string) – Last 4 Digit of the Account Number
Return type: Object

getCardLast4AccountNumber ()

Return type: String

setCardAccountNumber ($account_number)

Parameters:
$account_number (string) – Account Number
Return type: Object

getCardAccountNumber ()

Return type: String

setExpireMonth ($expire_month)

Parameters:
$expire_month (string) – Expire Month
Return type: Object

getExpireMonth ()

Return type: String

setExpireYear ($expire_year)

Parameters:
$expire_year (string) – Expire Year
Return type: Object

getExpireYear ()

Return type: String

setCardVerificationValue ($card_verification_value)

Parameters:
$card_verification_value (string) – Card Verification Value
Return type: Object

getCardVerificationValue ()

Return type: String

setProcurementCard ($procurement_card)

Parameters:
$procurement_card (string) – Procurement Card
Return type: Object

getProcurementCard ()

Return type: String

setCustomerAccountingCode ($customer_accounting_code)

Parameters:
$customer_accounting_code (string) – Customer Accounting Code
Return type: Object

getCustomerAccountingCode ()

Return type: String

setCardOneTimeToken ($one_time_token)

Parameters:
$one_time_token (string) – One Time Token
Return type: Object

getCardOneTimeToken ()

Return type: String

setCardReader ($card_reader)

Parameters:
$card_reader (string) – Card Reader
Return type: Object

getCardReader ()

Return type: String

setCardData ($card_data)

Parameters:
$card_data (string) – Card Data
Return type: Object

getCardData ()

Return type: String

setCardEmvData ($card_emv_data)

Parameters:
$card_emv_data (string) – Card EMV Data
Return type: Object

getCardEmvData ()

Return type: String

setFallbackSwipe ($fallback_swipe)

Parameters:
$fallback_swipe (boolean) – Fallback Swipe
Return type: Object

getFallbackSwipe ()

Return type: String

setAccountHolder ($account_holder)

Parameters:
$account_holder (string) – Account Holder
Return type: Object

getAccountHolder ()

Return type: String

setEcheckLast4AccountNumber ($last_4_account_number)

Parameters:
$last_4_account_number (string) – Last 4 Digit of the Account Number
Return type: Object

getEcheckLast4AccountNumber ()

Return type: String

setAccountNumber ($account_number)

Parameters:
$account_number (string) – Account Number
Return type: Object

getAccountNumber ()

Return type: String

setRoutingNumber ($routing_number)

Parameters:
$routing_number (string) – Routing Number
Return type: Object

getRoutingNumber ()

Return type: String

setAccountType ($account_type)

Parameters:
$account_type (string) – Account Type
Return type: Object

getAccountType ()

Return type: String

setItemDescription ($item_description)

Parameters:
$item_description (string) – Item Description
Return type: Object

getItemDescription ()

Return type: String

setSecCode ($sec_code)

Parameters:
$sec_code (string) – Standard-entry class code
Return type: Object

getSecCode ()

Return type: String

setEcheckOneTimeToken ($one_time_token)

Parameters:
$one_time_token (string) – One Time Token
Return type: Object

getEcheckOneTimeToken ()

Return type: String

setLineItemHeader ($line_item_header)

Parameters:
$line_item_header (string) – Line Item Header
Return type: Object

getLineItemHeader ()

Return type: String

setLineItemContents ($line_item_contents)

Parameters:
$line_item_contents (string) – Line Item Contents
Return type: Object

getLineItemContents ()

Return type: String

setXdata ($xdata)

Parameters:
$xdata (string) – Extra Data
Return type: Object

getXdata ()

Return type: String

transaction ()

Return type: Object

transactionAlternateURI ()

Return type: Object

transactionSale ()

Return type: Object

transactionCredit ()

Return type: Object

transactionAuthorize ()

Return type: Object

transactionVerify ()

Return type: Object

transactionForce ()

Return type: Object

getAllTransaction ()

Return type: Object

getAllSaleTransaction ()

Return type: Object

getAllCreditTransaction ()

Return type: Object

getAllAuthorizeTransaction ()

Return type: Object

getAllVerifyTransaction ()

Return type: Object

getAllInquiryTransaction ()

Return type: Object

getTransactionByCustomerToken ($customer_token)

Parameters:
$customer_token (string) – Customer Token
Return type: Object

getTransactionById ($transation_id)

Parameters:
$transation_id (string) – Transation Id
Return type: Object

getTransactionByDate ($start_date, $end_date)

Parameters:
$start_date (string) – Start Date $end_date (string) – End Date
Return type: Object

voidTransaction ($transation_id)

Parameters:
$transation_id (string) – Transation Id
Return type: Object