WC_Gateway_InSite_Redsys
extends WC_Payment_Gateway
in package
Gateway class
Table of Contents
Properties
- $butonbgcolor : string
- Description of the variable.
- $butontextcolor : string
- Description of the variable.
- $button_heigth : string
- Description of the variable.
- $button_width : string
- Description of the variable.
- $buttontext : string
- Description of the variable.
- $colorbutton : string
- Description of the variable.
- $colorfieldtext : string
- Description of the variable.
- $colortextbutton : string
- Description of the variable.
- $commercename : string
- Description of the variable.
- $customer : string
- Description of the variable.
- $customfieldname : string
- Description of the variable.
- $customtestsha256 : string
- Description of the variable.
- $cvvboxcolor : string
- Description of the variable.
- $debug : bool
- Description of the variable.
- $descripredsys : string
- Description of the variable.
- $description : string
- Description of the variable.
- $disablesubscrippaid : string
- Description of the variable.
- $enabled : string
- Description of the variable.
- $has_fields : bool
- Description of the variable.
- $hashtype : string
- Description of the variable.
- $hideownsetting : string
- Description of the variable.
- $icon : string
- Description of the variable.
- $id : string
- Description of the variable.
- $insitelanguage : string
- Description of the variable.
- $insitetype : string
- Description of the variable.
- $is_valid_for_use : bool
- Description of the variable.
- $liveurl : string
- Description of the variable.
- $liveurlws : string
- Description of the variable.
- $liveurlws2 : string
- Description of the variable.
- $log : mixed
- Description of the variable.
- $logo : string
- Description of the variable.
- $lwvactive : string
- Description of the variable.
- $merchantgroup : string
- Description of the variable.
- $method_description : string
- Description of the variable.
- $method_title : string
- Description of the variable.
- $moveterms : string
- Description of the variable.
- $multisitesttings : string
- Description of the variable.
- $not_use_https : bool
- Description of the variable.
- $notiemail : string
- Description of the variable.
- $notify_url : string
- Description of the variable.
- $notify_url_not_https : string
- Description of the variable.
- $ownsetting : string
- Description of the variable.
- $pay1clic : string
- Description of the variable.
- $secretsha256 : string
- Description of the variable.
- $settings : array<string|int, mixed>
- Description of the variable.
- $supports : array<string|int, mixed>
- Description of the variable.
- $terminal : string
- Description of the variable.
- $testforuser : string
- Description of the variable.
- $testforuserid : string
- Description of the variable.
- $testmode : string
- Description of the variable.
- $testsha256 : string
- Description of the variable.
- $testshowgateway : string
- Description of the variable.
- $testurl : string
- Description of the variable.
- $testurlws : string
- Description of the variable.
- $testurlws2 : string
- Description of the variable.
- $textcolor : string
- Description of the variable.
- $textnotfillfilds : string
- Description of the variable.
- $title : string
- Description of the variable.
- $traactive : string
- Description of the variable.
- $traamount : string
- Description of the variable.
- $wooinsiteurlko : string
- Description of the variable.
Methods
- __construct() : void
- Constructor for the gateway.
- add_error_to_checkout() : mixed
- Add error to checkout
- add_insite_redsys2() : mixed
- Add the InSite JS to the checkout page.
- add_subscription_supports() : array<string|int, mixed>
- Add gateway to support subscriptions.
- admin_options() : mixed
- Admin Panel Options
- ask_for_refund() : bool
- Ask for refund
- check_confirm_cres() : mixed
- Check for InSite CRES
- check_confirm_pares() : mixed
- Check for PaRes
- check_ipn_request_is_valid() : mixed
- Check redsys IPN validity
- check_ipn_response() : mixed
- Check for Servired/RedSys HTTP Notification
- check_redsys_refund() : mixed
- Check if the pingback is valid
- check_token_insite_from_action_checkout() : mixed
- Check for valid token & prepare payment form.
- check_user_show_payment_method() : mixed
- Check if user is in test mode
- check_user_test_mode() : mixed
- Check if user is in test mode
- doing_scheduled_subscription_payment() : mixed
- Charge a WooCommerce subscription.
- get_insite_order() : mixed
- Get insite order
- get_js_header() : mixed
- Get JS Header
- get_redsys_sha256() : string
- Get SHA256.
- get_redsys_url_gateway() : mixed
- Get Redsys URL Gateway
- get_redsys_url_gateway_ws() : mixed
- Get Redsys URL Gateway WS
- hide_payment_method_add_method() : mixed
- Check if user is in test mode
- init_form_fields() : void
- Initialise Gateway Settings Form Fields
- is_valid_for_use() : bool
- Check if this gateway is enabled and available in the user's country
- move_terms_and_conditions() : mixed
- Move terms and conditions checkbox to the bottom of the checkout form.
- pay_with_token_c() : array<string|int, mixed>
- Process the payment and return the result.
- pay_with_token_r() : array<string|int, mixed>
- Process the payment and return the result
- payment_fields() : mixed
- Add payment fields on checkout page.
- process_payment() : mixed
- Process the payment and return the result
- process_refund() : mixed
- Process a refund if supported
- receipt_page() : void
- Receipt_page function.
- renew_sumo_subscription() : bool
- Renew SUMO Subscriptions
- renew_yith_subscription() : mixed
- Process Yith subscription
- save_field_update_order_meta() : mixed
- Save field update order meta.
- show_payment_method() : mixed
- Check if user is in test mode
- successful_request() : mixed
- Successful Payment.
- update_checkout_on_change() : mixed
- Update checkout on change.
Properties
$butonbgcolor
Description of the variable.
public
string
$butonbgcolor
$butontextcolor
Description of the variable.
public
string
$butontextcolor
$button_heigth
Description of the variable.
public
string
$button_heigth
$button_width
Description of the variable.
public
string
$button_width
$buttontext
Description of the variable.
public
string
$buttontext
$colorbutton
Description of the variable.
public
string
$colorbutton
$colorfieldtext
Description of the variable.
public
string
$colorfieldtext
$colortextbutton
Description of the variable.
public
string
$colortextbutton
$commercename
Description of the variable.
public
string
$commercename
$customer
Description of the variable.
public
string
$customer
$customfieldname
Description of the variable.
public
string
$customfieldname
$customtestsha256
Description of the variable.
public
string
$customtestsha256
$cvvboxcolor
Description of the variable.
public
string
$cvvboxcolor
$debug
Description of the variable.
public
bool
$debug
$descripredsys
Description of the variable.
public
string
$descripredsys
$description
Description of the variable.
public
string
$description
$disablesubscrippaid
Description of the variable.
public
string
$disablesubscrippaid
$enabled
Description of the variable.
public
string
$enabled
$has_fields
Description of the variable.
public
bool
$has_fields
$hashtype
Description of the variable.
public
string
$hashtype
$hideownsetting
Description of the variable.
public
string
$hideownsetting
$icon
Description of the variable.
public
string
$icon
$id
Description of the variable.
public
string
$id
$insitelanguage
Description of the variable.
public
string
$insitelanguage
$insitetype
Description of the variable.
public
string
$insitetype
$is_valid_for_use
Description of the variable.
public
bool
$is_valid_for_use
$liveurl
Description of the variable.
public
string
$liveurl
$liveurlws
Description of the variable.
public
string
$liveurlws
$liveurlws2
Description of the variable.
public
string
$liveurlws2
$log
Description of the variable.
public
mixed
$log
$logo
Description of the variable.
public
string
$logo
$lwvactive
Description of the variable.
public
string
$lwvactive
$merchantgroup
Description of the variable.
public
string
$merchantgroup
$method_description
Description of the variable.
public
string
$method_description
$method_title
Description of the variable.
public
string
$method_title
$moveterms
Description of the variable.
public
string
$moveterms
$multisitesttings
Description of the variable.
public
string
$multisitesttings
$not_use_https
Description of the variable.
public
bool
$not_use_https
$notiemail
Description of the variable.
public
string
$notiemail
$notify_url
Description of the variable.
public
string
$notify_url
$notify_url_not_https
Description of the variable.
public
string
$notify_url_not_https
$ownsetting
Description of the variable.
public
string
$ownsetting
$pay1clic
Description of the variable.
public
string
$pay1clic
$secretsha256
Description of the variable.
public
string
$secretsha256
$settings
Description of the variable.
public
array<string|int, mixed>
$settings
$supports
Description of the variable.
public
array<string|int, mixed>
$supports
$terminal
Description of the variable.
public
string
$terminal
$testforuser
Description of the variable.
public
string
$testforuser
$testforuserid
Description of the variable.
public
string
$testforuserid
$testmode
Description of the variable.
public
string
$testmode
$testsha256
Description of the variable.
public
string
$testsha256
$testshowgateway
Description of the variable.
public
string
$testshowgateway
$testurl
Description of the variable.
public
string
$testurl
$testurlws
Description of the variable.
public
string
$testurlws
$testurlws2
Description of the variable.
public
string
$testurlws2
$textcolor
Description of the variable.
public
string
$textcolor
$textnotfillfilds
Description of the variable.
public
string
$textnotfillfilds
$title
Description of the variable.
public
string
$title
$traactive
Description of the variable.
public
string
$traactive
$traamount
Description of the variable.
public
string
$traamount
$wooinsiteurlko
Description of the variable.
public
string
$wooinsiteurlko
Methods
__construct()
Constructor for the gateway.
public
__construct() : void
add_error_to_checkout()
Add error to checkout
public
add_error_to_checkout() : mixed
add_insite_redsys2()
Add the InSite JS to the checkout page.
public
add_insite_redsys2() : mixed
add_subscription_supports()
Add gateway to support subscriptions.
public
static add_subscription_supports(array<string|int, mixed> $subscription_gateways) : array<string|int, mixed>
Parameters
- $subscription_gateways : array<string|int, mixed>
-
Subscription gateways.
Return values
array<string|int, mixed>admin_options()
Admin Panel Options
public
admin_options() : mixed
Tags
ask_for_refund()
Ask for refund
public
ask_for_refund(int $order_id, string $transaction_id, float $amount) : bool
Parameters
- $order_id : int
-
Order ID.
- $transaction_id : string
-
Transaction ID.
- $amount : float
-
Amount.
Return values
boolcheck_confirm_cres()
Check for InSite CRES
public
check_confirm_cres(array<string|int, mixed> $post) : mixed
Parameters
- $post : array<string|int, mixed>
-
$_POST data.
check_confirm_pares()
Check for PaRes
public
check_confirm_pares(array<string|int, mixed> $post) : mixed
Parameters
- $post : array<string|int, mixed>
-
$_POST data.
check_ipn_request_is_valid()
Check redsys IPN validity
public
check_ipn_request_is_valid() : mixed
check_ipn_response()
Check for Servired/RedSys HTTP Notification
public
check_ipn_response() : mixed
check_redsys_refund()
Check if the pingback is valid
public
check_redsys_refund(string $order_id) : mixed
Parameters
- $order_id : string
-
Order ID.
check_token_insite_from_action_checkout()
Check for valid token & prepare payment form.
public
static check_token_insite_from_action_checkout() : mixed
check_user_show_payment_method()
Check if user is in test mode
public
check_user_show_payment_method([int $userid = false ]) : mixed
Parameters
- $userid : int = false
-
User ID.
check_user_test_mode()
Check if user is in test mode
public
check_user_test_mode([int $userid = false ]) : mixed
Parameters
- $userid : int = false
-
User ID.
doing_scheduled_subscription_payment()
Charge a WooCommerce subscription.
public
doing_scheduled_subscription_payment(float $amount_to_charge, WC_Order $renewal_order) : mixed
Parameters
- $amount_to_charge : float
-
Amount to charge.
- $renewal_order : WC_Order
-
Order.
get_insite_order()
Get insite order
public
get_insite_order(int $order_id) : mixed
Parameters
- $order_id : int
-
Order ID.
get_js_header()
Get JS Header
public
get_js_header([int $user_id = false ]) : mixed
Parameters
- $user_id : int = false
-
User ID.
get_redsys_sha256()
Get SHA256.
public
get_redsys_sha256([bool $user_id = false ]) : string
Parameters
- $user_id : bool = false
-
User ID.
Return values
stringget_redsys_url_gateway()
Get Redsys URL Gateway
public
get_redsys_url_gateway([int $user_id = false ]) : mixed
Parameters
- $user_id : int = false
-
User ID.
get_redsys_url_gateway_ws()
Get Redsys URL Gateway WS
public
get_redsys_url_gateway_ws([int $user_id = false ]) : mixed
Parameters
- $user_id : int = false
-
User ID.
hide_payment_method_add_method()
Check if user is in test mode
public
hide_payment_method_add_method(array<string|int, mixed> $available_gateways) : mixed
Parameters
- $available_gateways : array<string|int, mixed>
-
Available Gateways.
init_form_fields()
Initialise Gateway Settings Form Fields
public
init_form_fields() : void
is_valid_for_use()
Check if this gateway is enabled and available in the user's country
public
is_valid_for_use() : bool
Return values
boolmove_terms_and_conditions()
Move terms and conditions checkbox to the bottom of the checkout form.
public
move_terms_and_conditions() : mixed
pay_with_token_c()
Process the payment and return the result.
public
pay_with_token_c(int $order_id, string $token_id) : array<string|int, mixed>
Parameters
- $order_id : int
-
Order ID.
- $token_id : string
-
Token ID.
Return values
array<string|int, mixed>pay_with_token_r()
Process the payment and return the result
public
pay_with_token_r(int $order_id, string $token_id) : array<string|int, mixed>
Parameters
- $order_id : int
-
Order ID.
- $token_id : string
-
Token ID.
Return values
array<string|int, mixed>payment_fields()
Add payment fields on checkout page.
public
payment_fields() : mixed
process_payment()
Process the payment and return the result
public
process_payment(int $order_id) : mixed
Parameters
- $order_id : int
-
Order ID.
process_refund()
Process a refund if supported
public
process_refund(int $order_id[, float $amount = null ][, string $reason = '' ]) : mixed
Parameters
- $order_id : int
-
Order ID.
- $amount : float = null
-
Refund amount.
- $reason : string = ''
-
Refund reason.
receipt_page()
Receipt_page function.
public
receipt_page(mixed $order) : void
Parameters
- $order : mixed
-
Order.
renew_sumo_subscription()
Renew SUMO Subscriptions
public
renew_sumo_subscription(bool $bool, int $subscription_id, obj $renewal_order[, bool $retry = false ]) : bool
Parameters
- $bool : bool
-
True or false.
- $subscription_id : int
-
Subscription ID.
- $renewal_order : obj
-
Renewal Order.
- $retry : bool = false
-
True or false.
Return values
boolrenew_yith_subscription()
Process Yith subscription
public
renew_yith_subscription([WC_Order $renewal_order = null ][, bool $is_manual_renew = null ]) : mixed
Parameters
- $renewal_order : WC_Order = null
-
Order object.
- $is_manual_renew : bool = null
-
Is manual renew.
save_field_update_order_meta()
Save field update order meta.
public
save_field_update_order_meta(int $order_id) : mixed
Parameters
- $order_id : int
-
Order ID.
show_payment_method()
Check if user is in test mode
public
show_payment_method(array<string|int, mixed> $available_gateways) : mixed
Parameters
- $available_gateways : array<string|int, mixed>
-
Available Gateways.
successful_request()
Successful Payment.
public
successful_request(array<string|int, mixed> $posted) : mixed
Parameters
- $posted : array<string|int, mixed>
-
Post data after processing.
update_checkout_on_change()
Update checkout on change.
public
update_checkout_on_change(array<string|int, mixed> $fields) : mixed
Parameters
- $fields : array<string|int, mixed>
-
Fields.