Class GatewayPayments

$passphrase

The passphrase to set

$contact_info

An array of contact info including:

• id The contact ID
• client_id The ID of the client this contact belongs to
• user_id The user ID this contact belongs to (if any)
• contact_type The type of contact
• contact_type_id The ID of the contact type
• first_name The first name on the contact
• last_name The last name on the contact
• title The title of the contact
• company The company name of the contact
• address1 The address 1 line of the contact
• address2 The address 2 line of the contact
• city The city of the contact
• state An array of state info including:
  • code The 2 or 3-character state code
  • name The local name of the country
• country An array of country info including:
  • alpha2 The 2-character country code
  • alpha3 The 3-cahracter country code
  • name The english name of the country
  • alt_name The local name of the country
• zip The zip/postal code of the contact

$amount

The amount to charge this contact

$currency

The current to charge

$invoice_amounts

An array of invoices, each containing:

• id The ID of the invoice being processed
• amount The amount being processed for this invoice (which is included in $amount)

$options

An array of options including:

• description The Description of the charge
• return_url The URL to redirect users to after a successful payment
• recur An array of recurring info including:
  • start_date The date/time in UTC that the recurring payment begins
  • amount The amount to recur
  • term The term to recur
  • period The recurring period (day, week, month, year, onetime) used in conjunction with term in order to determine the next recurring payment

$gateway_id

The ID of the nonmerchant gateway to fetch, if null will return all nonmerchant gateways for the currency

$currency

The currency to charge

$client_id

The ID of the client that payment confirmation is being viewed for

$transaction_id

The ID of the transaction being confirmed

$contact_info

An array of contact info including:

• id The contact ID
• client_id The ID of the client this contact belongs to
• user_id The user ID this contact belongs to (if any)
• contact_type The type of contact
• contact_type_id The ID of the contact type
• first_name The first name on the contact
• last_name The last name on the contact
• title The title of the contact
• company The company name of the contact
• address1 The address 1 line of the contact
• address2 The address 2 line of the contact
• city The city of the contact
• state An array of state info including:
  • code The 2 or 3-character state code
  • name The local name of the country
• country An array of country info including:
  • alpha2 The 2-character country code
  • alpha3 The 3-cahracter country code
  • name The english name of the country
  • alt_name The local name of the country
• zip The zip/postal code of the contact

$amount

The amount to charge this contact

$currency

The current to charge

$invoice_amounts

An array of invoices, each containing: - id The ID of the invoice being processed - amount The amount being processed for this invoice (which is included in $amount)

$options

An array of options including: - description The Description of the charge - return_url The URL to redirect users to after a successful payment - recur An array of recurring info including: - start_date The date/time in UTC that the recurring payment begins - amount The amount to recur - term The term to recur - period The recurring period (day, week, month, year, onetime) used in conjunction with term in order to determine the next recurring payment

$gateway_id

The ID of the nonmerchant gateway to fetch, if null will return all nonmerchant gateways for the currency

$gateway_name

The file name of the gateway excluding any extension

$get

array of GET parameters passed into the callback request

$post

array of POST parameters passed into the callback request

An array of transaction data, may set errors using Input if the data appears invalid:

• client_id The ID of the client that attempted the payment
• amount The amount of the payment
• currency The currency of the payment
• invoices An array of invoices and the amount the payment should be applied to (if any) including:
  • id The ID of the invoice to apply to
  • amount The amount to apply to the invoice
• status The status of the transaction (approved, declined, void, pending, reconciled, refunded, returned)
• transaction_id The ID returned by the gateway to identify this transaction
• parent_transaction_id The ID returned by the gateway to identify this transaction's original transaction

$gateway_name

The file name of the gateway excluding any extension

$get

array of GET parameters passed into the callback request

$post

array of POST parameters passed into the callback request

An object representing the transaction if attempted, void otherwise. Check GatewayPayments::errors(), as some transactions may be attempted and yet still produce errors

$client_id

The ID of the client to submit the payment for

$type

The type of payment to submit "cc" or "ach"

$amount

The amount to process

$currency

The ISO 4217 currency code this payment is to be processed under

$account_info

An array of account info if no $account_id used, including:

• first_name The first name on the account
• last_name The last name on the account
• account_number The bank account number (if ach)
• routing_number The bank account routing number (if ach)
• type The bank account type (checking, savings, business_checking) (if ach)
• card_number The credit card number (if cc)
• card_exp The card expiration date in yyyymm format (if cc)
• card_security_code The card security code (if cc)
• address1 The address 1 line of the account holder
• address2 The address 2 line of the account holder
• city The city of the account holder
• state The 2 or 3 character state code
• country The 2 or 3 character country code
• zip The zip/postal code of the account holder
• reference_id The reference ID attached to this account given by the payment processor (if cc) (optional)
• client_reference_id The reference ID for the client this payment account belongs to (if cc) (optional)

$account_id

The account ID to be used to process the payment if no $account_info given

$options

An array of options including (optional):

• invoices An array of key/value pairs where each key represents an invoice ID and each value is the amount to apply to that invoice (optional, may not exceed $amount)
• staff_id The ID of the staff member that processed this payment
• email_receipt If true (default true), will send an email receipt to the client and BCC appropriate staff members

An object representing the transaction if attempted, void otherwise. Check GatewayPayments::errors(), as some transactions may be attempted and yet still produce errors

$client_id

The ID of the client to authorize the payment for

$type

The type of payment to submit "cc" or "ach", NOTE: Only "cc" is supported, but this varaible remains for consistency (and possible future support)

$amount

The amount to authorize

$currency

The ISO 4217 currency code this payment is to be processed under

$account_info

An array of account info if no $account_id used, including:

• first_name The first name on the account
• last_name The last name on the account
• account_number The bank account number (if ach)
• routing_number The bank account routing number (if ach)
• type The bank account type (checking, savings, business_checking) (if ach)
• card_number The credit card number (if cc)
• card_exp The card expiration date in yyyymm format (if cc)
• card_security_code The card security code (if cc)
• address1 The address 1 line of the account holder
• address2 The address 2 line of the account holder
• city The city of the account holder
• state The 2 or 3 character state code
• country The 2 or 3 character country code
• zip The zip/postal code of the account holder

$account_id

The account ID to be used to process the payment if no $account_info given

$options

An array of options including (optional):

• invoices An array of key/value pairs where each key represents an invoice ID and each value is the amount to apply to that invoice (optional, may not exceed $amount)
• staff_id The ID of the staff member that processed this payment
• email_receipt If true (default true), will send an email receipt to the client and BCC appropriate staff members

An object representing the transaction if attempted, void otherwise. Check GatewayPayments::errors(), as some transactions may be attempted and yet still produce errors

$client_id

The ID of the client to capture the payment for

$transaction_id

The ID of the transactiosn to capture

$amount

The amount to capture

$options

An array of options including (optional):

• invoices An array of key/value pairs where each key represents an invoice ID and each value is the amount to apply to that invoice (optional, may not exceed $amount)
• staff_id The ID of the staff member that processed this payment
• email_receipt If true (default true), will send an email receipt to the client and BCC appropriate staff members

An object representing the transaction if attempted, void otherwise. Check GatewayPayments::errors(), as some transactions may be attempted and yet still produce errors

$client_id

The ID of the client to refund the payment for

$transaction_id

The ID of the transactiosn to refund

$amount

The amount to refund, defaults to the original transaction amount if not given

$options

An array of options including (optional):

• staff_id The ID of the staff member that processed this payment
• notes Any additional notes to include with this transaction

An object representing the transaction if attempted, void otherwise. Check GatewayPayments::errors(), as some transactions may be attempted and yet still produce errors

$client_id

The ID of the client to refund the payment for

$transaction_id

The ID of the transactiosn to refund

$options

An array of options including (optional):

• staff_id The ID of the staff member that processed this payment

An object representing the transaction if attempted, void otherwise. Check GatewayPayments::errors(), as some transactions may be attempted and yet still produce errors

$type

The type of account ("cc" or "ach")

$vars

An array of ACH or CC account info including:

• contact_id The contact ID tied to this account
• first_name The first name on the account
• last_name The last name on the account
• address1 The address line 1 on the account (optional)
• address2 The address line 2 on the account (optional)
• city The city on the account (optional)
• state The ISO 3166-2 subdivision code on the account (optional)
• zip The zip code on the account (optional)
• country The ISO 3166-1 2-character country code (optional, defaults to 'US')
• account The account number (if ach)
• routing The routing number (if ach)
• type The type of account, 'checking' or 'savings', (if ach, defaults to 'checking')
• card_number The card number (if cc)
• expiration The card expiration date in yyyymm format (if cc)
• security_code The card security code (if cc)
• reference_id The reference ID attached to this account given by the payment processor (optional)
• client_reference_id The reference ID for the client this payment account belongs to (optional)

False if the gateway does not support off-site payment accounts or is not enabled for off-site payment accounts, void for all other errors (errors set, use GatewayPayments::errors() to fetch errors), else sets an array containing:

• gateway_id The ID of the gateway used to process the request
• client_reference_id The reference ID for this client
• reference_id The reference ID for this payment account
• expiration The expiration date of the stored card (if cc) (optional)
• last4 The last four digits of the stored card (if cc) (optional)
• type The type of the stored card (e.g amex) (if cc) (optional)

$type

The type of account ("cc" or "ach")

$account

The existing account record that is to be updated

$vars

An array of ACH or CC account info including:

• contact_id The contact ID tied to this account
• first_name The first name on the account
• last_name The last name on the account
• address1 The address line 1 on the account (optional)
• address2 The address line 2 on the account (optional)
• city The city on the account (optional)
• state The ISO 3166-2 subdivision code on the account (optional)
• zip The zip code on the account (optional)
• country The ISO 3166-1 2-character country code (optional, defaults to 'US')
• account The account number (if ach)
• routing The routing number (if ach)
• type The type of account, 'checking' or 'savings', (if ach, defaults to 'checking')
• card_number The card number (if cc)
• expiration The card expiration date in yyyymm format (if cc)
• security_code The card security code (if cc)
• reference_id The reference ID attached to this account given by the payment processor (optional)
• client_reference_id The reference ID for the client this payment account belongs to (optional)
• account_changed True if the account details (bank account or card number, etc.) have been updated, false otherwise

False if the gateway does not support off-site payment accounts or is not enabled for off-site payment accounts, void for all other errors (errors set, use GatewayPayments::errors() to fetch errors), else sets an array containing:

• gateway_id The ID of the gateway used to process the request
• client_reference_id The reference ID for this client
• reference_id The reference ID for this payment account
• expiration The expiration date of the stored card (if cc) (optional)
• last4 The last four digits of the stored card (if cc) (optional)
• type The type of the stored card (e.g amex) (if cc) (optional)

$type

The type of account ("cc" or "ach")

$account

The existing account record that is to be updated

False if the gateway does not support off-site payment accounts or is not enabled for off-site payment accounts, void for all other errors (errors set, use GatewayPayments::errors() to fetch errors), else sets an array containing:

• gateway_id The ID of the gateway used to process the request
• client_reference_id The reference ID for this client
• reference_id The reference ID for this payment account

$type

The type of merchant gateway (cc or ach)

$gateway_obj

gateway object

$off_site

True if attempting to verify support for off site payments, false otherwise