Documentation

WC_Gateway_Redsys extends WC_Payment_Gateway
in package

WooCommerceRedsysGateway

Properties

$notify_url : mixed

Methods

__construct() : mixed: Constructor for the gateway.
add_ajax_url_header() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti
add_js_footer_checkout() : mixed: Add JS to footer filling the fields for PSD2.
add_payment_method() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti
add_subscription_supports() : array<string|int, mixed>: Add gateway to support subscriptions.
admin_options() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti
anadir_column() : mixed: Add colum
anadir_column_content() : mixed: Add colum to methods.
ask_for_collect_remainder() : bool: Ask for collect remainder
ask_for_confirm_preauthorization() : mixed: Ask for preauthorization confirmation
ask_for_refund() : bool: Ask for refund
charge_invoive_by_order() : mixed: Process Bulk Actions
check_collect_remainder() : mixed: Check if order is preauthorized
check_confirm_cres() : mixed: Check for CRES
check_confirm_pares() : mixed: Check for PaRes
check_confirm_preauth() : bool: Check if order is preauthorized
check_ipn_request_is_valid() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti
check_ipn_response() : void: Check for Servired/RedSys HTTP Notification
check_redsys_refund() : bool: Check if the order has been refunded
check_user_show_payment_method() : bool: Check if user can see payment method
check_user_test_mode() : mixed: Check if user is in test mode.
checkout_priority_fields() : mixed: Priority fields to checkout (Redsys needed fields).
custom_jquery_checkout() : mixed
doing_scheduled_subscription_payment() : mixed: Process the Subscription payment and return the result.
generate_redsys_form() : string: Generate the redsys form
generate_redsys_form_browser() : string: Generate the redsys form
generate_redsys_subscription_form() : string: Generate Subscriptions Form.
generate_redsys_subscription_form_browser() : string: Generate the redsys Subscription form
get_redsys_args() : array<string|int, mixed>: Get redsys Args for passing to PP
get_redsys_args_add_method() : mixed: Get redsys Args for passing Add Method.
get_redsys_args_p() : array<string|int, mixed>: Get Redsys Args for passing to TPV
get_redsys_sha256() : string: Get Redsys SHA256
get_redsys_url_gateway() : string: Get Redsys URL Gateway
get_redsys_url_gateway_p() : string: Get Redsys URL Gateway
get_redsys_url_gateway_ws() : mixed: Get Redsys URL Gateway by User ID
hide_payment_method_add_method() : mixed: Hide payment method Add Method
hide_payment_method_by_country_redsys() : mixed: Hide payment method by country
init_form_fields() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti
is_valid_for_use() : mixed: Check if this gateway is enabled and available in the user's country
override_checkout_fields() : mixed: Add fields to checkout (Redsys needed fields).
pay_with_token_c() : bool: Function pay_with_token_c
pay_with_token_r() : mixed: Process the payment and return the result
payment_fields() : mixed: Payment_fields function.
process_payment() : mixed: Process the payment and return the result
process_refund() : bool|WP_Error: Process a refund if supported.
receipt_page() : mixed: Output for the order received page.
redirect_to_checkout() : mixed: Redirecto to checkout.
redsys_add_bulk_actions() : mixed: Add Bulk Actions
redsys_bulk_actions_handler() : mixed: Bulk Actions Handler
redsys_charge_depo_js_callback() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti
redsys_handle_requests() : mixed: Redsys hadler.
redsys_preauthorized_js_callback() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti
redsys_process_payment_token() : mixed: Process the payment and return the result.
renew_sumo_subscription() : bool: Renew SUMO Subscriptions
renew_yith_subscription() : mixed: Change Yith Subscription.
save_field_update_order_meta() : mixed: Save fields to checkout (Redsys needed fields).
show_payment_method() : array<string|int, mixed>: Check if user can see payment method
successful_request() : mixed: Successful Payment.
thankyou_redirect() : mixed: Redirect to thankyou page.
warning_checkout_test_mode() : mixed: Package: WooCommerce Redsys Gateway Plugin URI: https://woo.com/products/redsys-gateway/ Copyright: (C) 2013 - 2024 José Conti

$notify_url


    public
        mixed
    $notify_url

__construct()

Constructor for the gateway.


    public
                    __construct() : mixed

add_ajax_url_header()


    public
                    add_ajax_url_header() : mixed

add_js_footer_checkout()

Add JS to footer filling the fields for PSD2.


    public
                    add_js_footer_checkout() : mixed

add_payment_method()


    public
                    add_payment_method() : 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>

Return values

array<string|int, mixed>

admin_options()


    public
                    admin_options() : mixed

anadir_column()

Add colum


    public
                    anadir_column(array<string|int, mixed> $columns) : mixed

Parameters

$columns : array<string|int, mixed>: Colums.

anadir_column_content()

Add colum to methods.


    public
                    anadir_column_content(array<string|int, mixed> $method) : mixed

Parameters

$method : array<string|int, mixed>: Method.

ask_for_collect_remainder()

Ask for collect remainder


    public
                    ask_for_collect_remainder(int $order_id, string $amount) : bool

Parameters

$order_id : int: Order ID.
$amount : string: Amount.

Return values

bool

ask_for_confirm_preauthorization()

Ask for preauthorization confirmation


    public
                    ask_for_confirm_preauthorization(int $order_id, int $transaction_id, int $amount) : mixed

Parameters

$order_id : int: Order ID.
$transaction_id : int: Transaction ID.
$amount : int: Amount.

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

bool

charge_invoive_by_order()

Process Bulk Actions


    public
            static        charge_invoive_by_order(object $order) : mixed

Parameters

$order : object: Redirect to.

check_collect_remainder()

Check if order is preauthorized


    public
                    check_collect_remainder(int $order_id) : mixed

Parameters

$order_id : int: Order ID.

check_confirm_cres()

Check for 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_confirm_preauth()

Check if order is preauthorized


    public
                    check_confirm_preauth(int $order_id) : bool

Parameters

$order_id : int: Order ID.

Return values

bool

check_ipn_request_is_valid()


    public
                    check_ipn_request_is_valid() : mixed

check_ipn_response()

Check for Servired/RedSys HTTP Notification


    public
                    check_ipn_response() : void

check_redsys_refund()

Check if the order has been refunded


    public
                    check_redsys_refund(int $order_id) : bool

Parameters

$order_id : int: Order ID.

Return values

bool

check_user_show_payment_method()

Check if user can see payment method


    public
                    check_user_show_payment_method([int $userid = false ]) : bool

Parameters

$userid : int = false: User ID.

Return values

bool

check_user_test_mode()

Check if user is in test mode.


    public
                    check_user_test_mode(int $userid) : mixed

Parameters

$userid : int: User ID.

checkout_priority_fields()

Priority fields to checkout (Redsys needed fields).


    public
                    checkout_priority_fields(array<string|int, mixed> $fields) : mixed

Parameters

$fields : array<string|int, mixed>: Fields to Add.

custom_jquery_checkout()


    public
                    custom_jquery_checkout() : mixed

doing_scheduled_subscription_payment()

Process the Subscription payment and return the result.


    public
                    doing_scheduled_subscription_payment(int $amount_to_charge, int $renewal_order) : mixed

Parameters

$amount_to_charge : int: Amount to charge.
$renewal_order : int: Renewal ID.

generate_redsys_form()

Generate the redsys form


    public
                    generate_redsys_form(mixed $order_id) : string

Parameters

$order_id : mixed: Order ID.

Return values

string

generate_redsys_form_browser()

Generate the redsys form


    public
                    generate_redsys_form_browser(int $order_id) : string

Parameters

$order_id : int: Order ID.

Return values

string —

Form fields

generate_redsys_subscription_form()

Generate Subscriptions Form.


    public
                    generate_redsys_subscription_form(int $order_id) : string

Parameters

$order_id : int: Order ID.

Return values

string

generate_redsys_subscription_form_browser()

Generate the redsys Subscription form


    public
                    generate_redsys_subscription_form_browser(mixed $order_id) : string

Parameters

$order_id : mixed: Order ID.

Return values

string

get_redsys_args()

Get redsys Args for passing to PP


    public
                    get_redsys_args(WC_Order $order) : array<string|int, mixed>

Parameters

$order : WC_Order: Order object.

Return values

array<string|int, mixed>

get_redsys_args_add_method()

Get redsys Args for passing Add Method.


    public
            static        get_redsys_args_add_method(int $order_id) : mixed

Parameters

$order_id : int: Order ID.

get_redsys_args_p()

Get Redsys Args for passing to TPV


    public
            static        get_redsys_args_p([WC_Order $order = false ][, mixed $subscription_id = false ]) : array<string|int, mixed>

Parameters

$order : WC_Order = false: Order object.
$subscription_id : mixed = false

Return values

array<string|int, mixed>

get_redsys_sha256()

Get Redsys SHA256


    public
                    get_redsys_sha256(string $user_id) : string

Parameters

$user_id : string: User ID.

Return values

string

get_redsys_url_gateway()

Get Redsys URL Gateway


    public
                    get_redsys_url_gateway(string $user_id[, string $type = 'rd' ]) : string

Parameters

$user_id : string: User ID.
$type : string = 'rd': Type.

Return values

string

get_redsys_url_gateway_p()

Get Redsys URL Gateway


    public
            static        get_redsys_url_gateway_p(string $user_id[, string $type = 'rd' ]) : string

Parameters

$user_id : string: User ID.
$type : string = 'rd': Type.

Return values

string

get_redsys_url_gateway_ws()

Get Redsys URL Gateway by User ID


    public
                    get_redsys_url_gateway_ws([int $user_id = false ]) : mixed

Parameters

$user_id : int = false: User ID.

hide_payment_method_add_method()

Hide payment method Add Method


    public
                    hide_payment_method_add_method(array<string|int, mixed> $available_gateways) : mixed

Parameters

$available_gateways : array<string|int, mixed>: All available gateways.

hide_payment_method_by_country_redsys()

Hide payment method by country


    public
                    hide_payment_method_by_country_redsys(array<string|int, mixed> $available_gateways) : mixed

Parameters

$available_gateways : array<string|int, mixed>: All available gateways.

init_form_fields()


    public
                    init_form_fields() : mixed

is_valid_for_use()

Check if this gateway is enabled and available in the user's country


    public
                    is_valid_for_use() : mixed

override_checkout_fields()

Add fields to checkout (Redsys needed fields).


    public
                    override_checkout_fields(array<string|int, mixed> $show_fields) : mixed

Parameters

$show_fields : array<string|int, mixed>: Fields to Add.

pay_with_token_c()

Function pay_with_token_c


    public
                    pay_with_token_c(int $order_id, string $token_id) : bool

Parameters

$order_id : int: Order ID.
$token_id : string: Token ID.

Return values

bool

pay_with_token_r()

Process the payment and return the result


    public
                    pay_with_token_r(int $order_id, int $token_id) : mixed

Parameters

$order_id : int: Order ID.
$token_id : int: Token ID.

payment_fields()

Payment_fields function.


    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 = '' ]) : bool|WP_Error

Parameters

$order_id : int: Order ID.
$amount : float = null: Refund amount.
$reason : string = '': Refund reason.

Return values

bool|WP_Error —

True or false based on success, or a WP_Error object.

receipt_page()

Output for the order received page.


    public
                    receipt_page(int $order) : mixed

Parameters

$order : int: Order ID.

redirect_to_checkout()

Redirecto to checkout.


    public
                    redirect_to_checkout() : mixed

redsys_add_bulk_actions()

Add Bulk Actions


    public
            static        redsys_add_bulk_actions(array<string|int, mixed> $bulk_actions) : mixed

Parameters

$bulk_actions : array<string|int, mixed>: All bulk actions.

redsys_bulk_actions_handler()

Bulk Actions Handler


    public
            static        redsys_bulk_actions_handler(string $redirect_to, string $doaction, array<string|int, mixed> $post_ids) : mixed

Parameters

$redirect_to : string: Where redirect to.
$doaction : string: Action.
$post_ids : array<string|int, mixed>: Post ids.

redsys_charge_depo_js_callback()


    public
            static        redsys_charge_depo_js_callback() : mixed

redsys_handle_requests()

Redsys hadler.


    public
            static        redsys_handle_requests(array<string|int, mixed> $wp) : mixed

Parameters

$wp : array<string|int, mixed>: Array.

redsys_preauthorized_js_callback()


    public
            static        redsys_preauthorized_js_callback() : mixed

redsys_process_payment_token()

Process the payment and return the result.


    public
                    redsys_process_payment_token(int $order_id) : mixed

Parameters

$order_id : int: Order ID.

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

bool

renew_yith_subscription()

Change Yith Subscription.


    public
                    renew_yith_subscription([int $renewal_order = null ][, int $is_manual_renew = null ]) : mixed

Parameters

$renewal_order : int = null: Renewal Order.
$is_manual_renew : int = null: Is Manual Renew.

save_field_update_order_meta()

Save fields to checkout (Redsys needed fields).


    public
                    save_field_update_order_meta(int $order_id) : mixed

Parameters

$order_id : int: Order ID.

show_payment_method()

Check if user can see payment method


    public
                    show_payment_method(array<string|int, mixed> $available_gateways) : array<string|int, mixed>

Parameters

$available_gateways : array<string|int, mixed>: Available gateways.

Return values

array<string|int, mixed>

successful_request()

Successful Payment.


    public
                    successful_request(array<string|int, mixed> $posted) : mixed

Parameters

$posted : array<string|int, mixed>: Post data after notify.

thankyou_redirect()

Redirect to thankyou page.


    public
                    thankyou_redirect(int $order_id) : mixed

Parameters

$order_id : int: Order ID.

warning_checkout_test_mode()


    public
                    warning_checkout_test_mode() : mixed

WC_Gateway_Redsys extends WC_Payment_Gateway in package WooCommerceRedsysGateway

Table of Contents

Properties

Methods

Properties

$notify_url

Methods

__construct()

add_ajax_url_header()

add_js_footer_checkout()

add_payment_method()

add_subscription_supports()

Parameters

Return values

admin_options()

anadir_column()

Parameters

anadir_column_content()

Parameters

ask_for_collect_remainder()

Parameters

Return values

ask_for_confirm_preauthorization()

Parameters

ask_for_refund()

Parameters

Return values

charge_invoive_by_order()

Parameters

check_collect_remainder()

Parameters

check_confirm_cres()

Parameters

check_confirm_pares()

Parameters

check_confirm_preauth()

Parameters

Return values

check_ipn_request_is_valid()

check_ipn_response()

check_redsys_refund()

Parameters

Return values

check_user_show_payment_method()

Parameters

Return values

check_user_test_mode()

Parameters

checkout_priority_fields()

Parameters

custom_jquery_checkout()

doing_scheduled_subscription_payment()

Parameters

generate_redsys_form()

Parameters

Return values

generate_redsys_form_browser()

Parameters

Return values

generate_redsys_subscription_form()

Parameters

Return values

generate_redsys_subscription_form_browser()

Parameters

Return values

get_redsys_args()

Parameters

Return values

get_redsys_args_add_method()

Parameters

get_redsys_args_p()

Parameters

Return values

get_redsys_sha256()

Parameters

Return values

get_redsys_url_gateway()

Parameters

Return values

get_redsys_url_gateway_p()

WC_Gateway_Redsys extends WC_Payment_Gateway
in package

WooCommerceRedsysGateway