Merchant Credit Card offsite processing interface. Defines all methods that a
credit card offsite payment gateway must implement. Note: not all methods are
required to be supported.
All Credit Card offsite gateways support storing customer information with
the gateway processor rather than within the system. This removes the burden of
secure storage from the merchant and places it in the hands of the gateway
processor.
public
mixed
|
#
storeCc( array $card_info, array $contact, string $client_reference_id = null )
Store a credit card off site
Store a credit card off site
Parameters
- $card_info
array
$card_info An array of card info to store off site including: - first_name The
first name on the card - last_name The last name on the card - card_number The
card number - card_exp The card expiration date in yyyymm format -
card_security_code The 3 or 4 digit security code of the card (if available) -
type The credit card type - address1 The address 1 line of the card holder -
address2 The address 2 line of the card holder - city The city of the card
holder - 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-character
country code - name The english name of the country - alt_name The local name of
the country - zip The zip/postal code of the card holder- $contact
array
$contact An array of contact information for the billing contact this account is
to be set up under including: - id The ID of the contact - client_id The ID of
the client this contact resides under - user_id The ID of the user this contact
represents - contact_type The contact type - contact_type_id The reference ID
for this custom contact type - contact_type_name The name of the contact type -
first_name The first name of the contact - last_name The last name of the
contact - title The title of the contact - company The company name of the
contact - email The email address of the contact - address1 The address of the
contact - address2 The address line 2 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-character
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 - date_added The date/time
the contact was added- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway (if
one exists) Returns
mixed
False on failure or an array containing: - client_reference_id The reference ID
for this client - reference_id The reference ID for this payment account
|
public
mixed
|
#
updateCc( array $card_info, array $contact, string $client_reference_id, string $account_reference_id )
Update a credit card stored off site
Update a credit card stored off site
Parameters
- $card_info
array
$card_info An array of card info to store off site including: - first_name The
first name on the card - last_name The last name on the card - card_number The
card number - card_exp The card expiration date in yyyymm format -
card_security_code The 3 or 4 digit security code of the card (if available) -
type The credit card type - address1 The address 1 line of the card holder -
address2 The address 2 line of the card holder - city The city of the card
holder - 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-character
country code - name The english name of the country - alt_name The local name of
the country - zip The zip/postal code of the card holder - account_changed True
if the account details (bank account or card number, etc.) have been updated,
false otherwise- $contact
array
$contact An array of contact information for the billing contact this account is
to be set up under including: - id The ID of the contact - client_id The ID of
the client this contact resides under - user_id The ID of the user this contact
represents - contact_type The contact type - contact_type_id The reference ID
for this custom contact type - contact_type_name The name of the contact type -
first_name The first name of the contact - last_name The last name of the
contact - title The title of the contact - company The company name of the
contact - email The email address of the contact - address1 The address of the
contact - address2 The address line 2 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-character
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 - date_added The date/time
the contact was added- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway- $account_reference_id
string
$account_reference_id The reference ID for the stored account on the remote
gateway to update Returns
mixed
False on failure or an array containing: - client_reference_id The reference ID
for this client - reference_id The reference ID for this payment account
|
public
array
|
#
removeCc( string $client_reference_id, string $account_reference_id )
Remove a credit card stored off site
Remove a credit card stored off site
Parameters
- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway- $account_reference_id
string
$account_reference_id The reference ID for the stored account on the remote
gateway to remove Returns
array
An array containing: - client_reference_id The reference ID for this client -
reference_id The reference ID for this payment account
|
public
array
|
#
processStoredCc( string $client_reference_id, string $account_reference_id, float $amount, array $invoice_amounts = null )
Charge a credit card stored off site
Charge a credit card stored off site
Parameters
- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway- $account_reference_id
string
$account_reference_id The reference ID for the stored account on the remote
gateway to update- $amount
float
$amount The amount to process- $invoice_amounts
array
$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) Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
public
array
|
#
authorizeStoredCc( string $client_reference_id, string $account_reference_id, float $amount, array $invoice_amounts = null )
Authorize a credit card stored off site (do not charge)
Authorize a credit card stored off site (do not charge)
Parameters
- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway- $account_reference_id
string
$account_reference_id The reference ID for the stored account on the remote
gateway to update- $amount
float
$amount The amount to authorize- $invoice_amounts
array
$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) Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
public
array
|
#
captureStoredCc( string $client_reference_id, string $account_reference_id, string $transaction_reference_id, string $transaction_id, float $amount, array $invoice_amounts = null )
Charge a previously authorized credit card stored off site
Charge a previously authorized credit card stored off site
Parameters
- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway- $account_reference_id
string
$account_reference_id The reference ID for the stored account on the remote
gateway to update- $transaction_reference_id
string
$transaction_reference_id The reference ID for the previously authorized
transaction- $transaction_id
string
$transaction_id The ID of the previously authorized transaction- $amount
float
$amount The amount to capture- $invoice_amounts
array
$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) Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
public
array
|
#
voidStoredCc( string $client_reference_id, string $account_reference_id, string $transaction_reference_id, string $transaction_id )
Void an off site credit card charge
Void an off site credit card charge
Parameters
- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway- $account_reference_id
string
$account_reference_id The reference ID for the stored account on the remote
gateway to update- $transaction_reference_id
string
$transaction_reference_id The reference ID for the previously authorized
transaction- $transaction_id
string
$transaction_id The ID of the previously authorized transaction Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
public
array
|
#
refundStoredCc( string $client_reference_id, string $account_reference_id, string $transaction_reference_id, string $transaction_id, float $amount )
Refund an off site credit card charge
Refund an off site credit card charge
Parameters
- $client_reference_id
string
$client_reference_id The reference ID for the client on the remote gateway- $account_reference_id
string
$account_reference_id The reference ID for the stored account on the remote
gateway to update- $transaction_reference_id
string
$transaction_reference_id The reference ID for the previously authorized
transaction- $transaction_id
string
$transaction_id The ID of the previously authorized transaction- $amount
float
$amount The amount to refund Returns
array
An array of transaction data including: - status The status of the transaction
(approved, declined, void, pending, reconciled, refunded, returned) -
reference_id The reference ID for gateway-only use with this transaction
(optional) - transaction_id The ID returned by the remote gateway to identify
this transaction - message The message to be displayed in the interface in
addition to the standard message for this transaction status (optional)
|
public
boolean
|
#
requiresCcStorage( )
Used to determine if offsite credit card customer account information is
enabled for the gateway This is invoked after the gateway has been initialized
and after Gateway::setMeta() has been called. The gateway should examine its
current settings to verify whether or not the system should invoke the gateway's
offsite methods
Used to determine if offsite credit card customer account information is
enabled for the gateway This is invoked after the gateway has been initialized
and after Gateway::setMeta() has been called. The gateway should examine its
current settings to verify whether or not the system should invoke the gateway's
offsite methods
Returns
boolean
True if the gateway expects the offset methods to be called for credit card
payments, false to process the normal methods instead
|