Automattic\WooCommerce\Internal\Admin\Settings\PaymentProviders\WooPayments
WooPaymentsRestController{} │ WC 1.0└─ RestApiControllerBase
Controller for the WooPayments-specific REST endpoints to service the Payments settings page.
Хуков нет.
Использование
$WooPaymentsRestController = new WooPaymentsRestController(); // use class methods
Методы
- public get_rest_url_path( string $relative_path = '' )
- public init( Payments $payments, WooPaymentsService $woopayments )
- public register_routes( bool $override = false )
- private check_location_arg( $value, WP_REST_Request $request )
- private check_permissions( WP_REST_Request $request )
- protected get_onboarding_details( WP_REST_Request $request )
- protected get_rest_api_namespace()
- private get_schema_for_get_onboarding_details()
- private get_schema_properties_for_onboarding_step_action()
- protected get_woopay_eligibility()
- protected handle_onboarding_business_verification_kyc_session_finish( WP_REST_Request $request )
- protected handle_onboarding_business_verification_kyc_session_init( WP_REST_Request $request )
- protected handle_onboarding_preload( WP_REST_Request $request )
- protected handle_onboarding_step_check( WP_REST_Request $request )
- protected handle_onboarding_step_clean( WP_REST_Request $request )
- protected handle_onboarding_step_finish( WP_REST_Request $request )
- protected handle_onboarding_step_save( WP_REST_Request $request )
- protected handle_onboarding_step_start( WP_REST_Request $request )
- protected handle_onboarding_test_account_init( WP_REST_Request $request )
- protected handle_test_account_disable( WP_REST_Request $request )
- private prepare_onboarding_details_response( array $response )
- private prepare_onboarding_details_response_recursive( $response_item, array $schema )
- protected reset_onboarding( WP_REST_Request $request )
Код WooPaymentsRestController{} WooPaymentsRestController{} WC 9.9.5
class WooPaymentsRestController extends RestApiControllerBase {
/**
* The root namespace for the JSON REST API endpoints.
*
* @var string
*/
protected string $route_namespace = 'wc-admin';
/**
* Route base.
*
* @var string
*/
protected string $rest_base = 'settings/payments/woopayments';
/**
* The payments settings page service.
*
* @var Payments
*/
private Payments $payments;
/**
* The WooPayments-specific Payments settings page service.
*
* @var WooPaymentsService
*/
private WooPaymentsService $woopayments;
/**
* Get the WooCommerce REST API namespace for the class.
*
* @return string
*/
protected function get_rest_api_namespace(): string {
return 'wc-admin-settings-payments-woopayments';
}
/**
* Register the REST API endpoints handled by this controller.
*
* @param bool $override Whether to override the existing routes. Useful for testing.
*/
public function register_routes( bool $override = false ) {
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding',
array(
array(
'methods' => \WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_onboarding_details' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
'schema' => fn() => $this->get_schema_for_get_onboarding_details(),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P<step>[a-zA-Z0-9_-]+)/start',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_start' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P<step>[a-zA-Z0-9_-]+)/save',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_save' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P<step>[a-zA-Z0-9_-]+)/check',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_check' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P<step>[a-zA-Z0-9_-]+)/finish',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_finish' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P<step>[a-zA-Z0-9_-]+)/clean',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_clean' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
// Onboarding step specific routes.
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_TEST_ACCOUNT . '/init',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_test_account_init' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/kyc_session',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_business_verification_kyc_session_init' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/kyc_session/finish',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_business_verification_kyc_session_finish' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/preload',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_preload' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/reset',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'reset_onboarding' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'from' => array(
'description' => esc_html__( 'Where from in the onboarding flow this request was triggered.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/woopay-eligibility',
array(
array(
'methods' => \WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_woopay_eligibility' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/test_account/disable',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_test_account_disable' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'from' => array(
'description' => esc_html__( 'Where from in the onboarding flow this request was triggered.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
}
/**
* Get the controller's REST URL path.
*
* @param string $relative_path Optional. Relative path to append to the REST URL.
*
* @return string The REST URL path.
*/
public function get_rest_url_path( string $relative_path = '' ): string {
$path = '/' . trim( $this->route_namespace, '/' ) . '/' . trim( $this->rest_base, '/' );
if ( ! empty( $relative_path ) ) {
$path .= '/' . ltrim( $relative_path, '/' );
}
return $path;
}
/**
* Initialize the class instance.
*
* @param Payments $payments The general payments settings page service.
* @param WooPaymentsService $woopayments The WooPayments-specific Payments settings page service.
*
* @internal
*/
final public function init( Payments $payments, WooPaymentsService $woopayments ): void {
$this->payments = $payments;
$this->woopayments = $woopayments;
}
/**
* Get the onboarding details for the given location.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function get_onboarding_details( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$onboarding_details = $this->woopayments->get_onboarding_details( $location, $this->get_rest_url_path( 'onboarding' ) );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_rest_woopayments_onboarding_error', $e->getMessage(), array( 'status' => WP_Http::INTERNAL_SERVER_ERROR ) );
}
return rest_ensure_response( $this->prepare_onboarding_details_response( $onboarding_details ) );
}
/**
* Handle the onboarding step start action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_start( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$previous_status = $this->woopayments->get_onboarding_step_status( $step_id, $location );
$this->woopayments->mark_onboarding_step_started( $step_id, $location );
$response = array(
'success' => true,
'previous_status' => $previous_status,
'current_status' => $this->woopayments->get_onboarding_step_status( $step_id, $location ),
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding step save action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response.
*/
protected function handle_onboarding_step_save( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$this->woopayments->onboarding_step_save( $step_id, $location, $request->get_params() );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( array( 'success' => true ) );
}
/**
* Handle the onboarding step check action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_check( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$result = $this->woopayments->onboarding_step_check( $step_id, $location );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
// Merge the result with the success flag.
$response = array_merge( array( 'success' => true ), $result );
return rest_ensure_response( $response );
}
/**
* Handle the onboarding step finish action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_finish( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$previous_status = $this->woopayments->get_onboarding_step_status( $step_id, $location );
$this->woopayments->mark_onboarding_step_completed( $step_id, $location );
$response = array(
'success' => true,
'previous_status' => $previous_status,
'current_status' => $this->woopayments->get_onboarding_step_status( $step_id, $location ),
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding step clean action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_clean( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$previous_status = $this->woopayments->get_onboarding_step_status( $step_id, $location );
$this->woopayments->clean_onboarding_step_progress( $step_id, $location );
$response = array(
'success' => true,
'previous_status' => $previous_status,
'current_status' => $this->woopayments->get_onboarding_step_status( $step_id, $location ),
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding test account initialize action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_test_account_init( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
// Mark the step as started, if not already.
$this->woopayments->mark_onboarding_step_started( WooPaymentsService::ONBOARDING_STEP_TEST_ACCOUNT, $location );
$result = $this->woopayments->onboarding_test_account_init( $location, $request->get_param( 'source' ) ?? '' );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array_merge(
array( 'success' => true ),
$result
)
);
}
/**
* Handle the onboarding business verification step KYC session initialization action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_business_verification_kyc_session_init( WP_REST_Request $request ) {
// If we receive self assessment data with the request, we will use it.
$self_assessment = ! empty( $request->get_param( 'self_assessment' ) ) ? wc_clean( wp_unslash( $request->get_param( 'self_assessment' ) ) ) : array();
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$account_session = $this->woopayments->get_onboarding_kyc_session( $location, $self_assessment );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array(
'success' => true,
'session' => $account_session,
)
);
}
/**
* Handle the onboarding business verification step KYC session finish action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_business_verification_kyc_session_finish( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$response = $this->woopayments->finish_onboarding_kyc_session( $location, $request->get_param( 'source' ) ?? '' );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
// If there is no success key in the response, we assume the operation was successful.
if ( ! isset( $response['success'] ) ) {
$response['success'] = true;
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding preload action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_preload( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$response = $this->woopayments->onboarding_preload( $location );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
// If there is no success key in the response, we assume the operation was successful.
if ( ! isset( $response['success'] ) ) {
$response['success'] = true;
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding reset action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function reset_onboarding( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$this->woopayments->reset_onboarding( $location, $request->get_param( 'from' ) ?? '', $request->get_param( 'source' ) ?? '' );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array(
'success' => true,
)
);
}
/**
* Handle the onboarding test mode disable action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_test_account_disable( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$this->woopayments->disable_test_account(
$location,
$request->get_param( 'from' ) ?? '',
$request->get_param( 'source' ) ?? ''
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array(
'success' => true,
)
);
}
/**
* Get WooPay eligibility status.
*
* @return WP_REST_Response The response.
*/
protected function get_woopay_eligibility() {
// We use the Payments Settings stored business location to determine the eligibility.
$location = $this->payments->get_country();
$woopay_eligible_countries = array( 'US' );
$is_eligible = in_array( $location, $woopay_eligible_countries, true );
return rest_ensure_response(
array(
'is_eligible' => $is_eligible,
)
);
}
/**
* General permissions check for WooPayments settings REST API endpoint.
*
* @param WP_REST_Request $request The request for which the permission is checked.
*
* @return bool|WP_Error True if the current user has the capability, otherwise an "Unauthorized" error or False if no error is available for the request method.
*/
private function check_permissions( WP_REST_Request $request ) {
$context = 'read';
if ( 'POST' === $request->get_method() ) {
$context = 'edit';
} elseif ( 'DELETE' === $request->get_method() ) {
$context = 'delete';
}
if ( wc_rest_check_manager_permissions( 'payment_gateways', $context ) ) {
return true;
}
$error_information = $this->get_authentication_error_by_method( $request->get_method() );
if ( is_null( $error_information ) ) {
return false;
}
return new WP_Error(
$error_information['code'],
$error_information['message'],
array( 'status' => rest_authorization_required_code() )
);
}
/**
* Validate the location argument.
*
* @param mixed $value Value of the argument.
* @param WP_REST_Request $request The current request object.
*
* @return WP_Error|true True if the location argument is valid, otherwise a WP_Error object.
*/
private function check_location_arg( $value, WP_REST_Request $request ) {
// If the 'location' argument is not a string return an error.
if ( ! is_string( $value ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The location argument must be a string.', 'woocommerce' ), array( 'status' => 400 ) );
}
// Get the registered attributes for this endpoint request.
$attributes = $request->get_attributes();
// Grab the location param schema.
$args = $attributes['args']['location'];
// If the location param doesn't match the regex pattern then we should return an error as well.
if ( ! preg_match( '/^' . $args['pattern'] . '$/', $value ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The location argument must be a valid ISO3166 alpha-2 country code.', 'woocommerce' ), array( 'status' => 400 ) );
}
return true;
}
/**
* Prepare the response for the GET onboarding details request.
*
* @param array $response The response to prepare.
*
* @return array The prepared response.
*/
private function prepare_onboarding_details_response( array $response ): array {
return $this->prepare_onboarding_details_response_recursive( $response, $this->get_schema_for_get_onboarding_details() );
}
/**
* Recursively prepare the response items for the GET onboarding details request.
*
* @param mixed $response_item The response item to prepare.
* @param array $schema The schema to use for preparing the response.
*
* @return mixed The prepared response item.
*/
private function prepare_onboarding_details_response_recursive( $response_item, array $schema ) {
if ( is_null( $response_item ) ||
! array_key_exists( 'properties', $schema ) ||
! is_array( $schema['properties'] ) ) {
return $response_item;
}
$prepared_response = array();
foreach ( $schema['properties'] as $key => $property_schema ) {
if ( is_array( $response_item ) && array_key_exists( $key, $response_item ) ) {
if ( is_array( $property_schema ) && array_key_exists( 'properties', $property_schema ) ) {
$prepared_response[ $key ] = $this->prepare_onboarding_details_response_recursive( $response_item[ $key ], $property_schema );
} elseif ( is_array( $property_schema ) && array_key_exists( 'items', $property_schema ) ) {
$prepared_response[ $key ] = array_map(
fn( $item ) => $this->prepare_onboarding_details_response_recursive( $item, $property_schema['items'] ),
$response_item[ $key ]
);
} else {
$prepared_response[ $key ] = $response_item[ $key ];
}
}
}
// Ensure the order is the same as in the schema.
$prepared_response = array_merge( array_fill_keys( array_keys( $schema['properties'] ), null ), $prepared_response );
// Remove any null values from the response.
$prepared_response = array_filter( $prepared_response, fn( $value ) => ! is_null( $value ) );
return $prepared_response;
}
/**
* Get the schema for the GET onboarding details request.
*
* @return array[]
*/
private function get_schema_for_get_onboarding_details(): array {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'WooCommerce Settings Payments WooPayments onboarding details for the given location.',
'type' => 'object',
);
$schema['properties'] = array(
'state' => array(
'type' => 'object',
'description' => esc_html__( 'The general state of the onboarding process.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'started' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the onboarding process is started.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'completed' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the onboarding process is completed.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'test_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the onboarding process is in test mode.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'dev_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether WooPayments is in dev mode.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'steps' => array(
'type' => 'array',
'description' => esc_html__( 'The onboarding steps.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'path' => array(
'type' => 'string',
'description' => esc_html__( 'The relative path of the step to use for frontend navigation.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'required_steps' => array(
'type' => 'array',
'description' => esc_html__( 'The steps that are required to be completed before this step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
),
),
'status' => array(
'type' => 'enum',
'description' => esc_html__( 'The current status of the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'enum' => array(
WooPaymentsService::ONBOARDING_STEP_STATUS_NOT_STARTED,
WooPaymentsService::ONBOARDING_STEP_STATUS_STARTED,
WooPaymentsService::ONBOARDING_STEP_STATUS_COMPLETED,
),
),
'errors' => array(
'type' => 'array',
'description' => esc_html__( 'Errors list for the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
),
),
'actions' => array(
'type' => 'object',
'description' => esc_html__( 'The available actions for the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'start' => array(
'type' => 'object',
'description' => esc_html__( 'Action to signal the step start.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'save' => array(
'type' => 'object',
'description' => esc_html__( 'Action to save step information in the database.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'check' => array(
'type' => 'object',
'description' => esc_html__( 'Action to check the step status.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'finish' => array(
'type' => 'object',
'description' => esc_html__( 'Action to signal the step completion.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'clean' => array(
'type' => 'object',
'description' => esc_html__( 'Action to clean the step progress.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'auth' => array(
'type' => 'object',
'description' => esc_html__( 'Action to authorize the WPCOM connection.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'init' => array(
'type' => 'object',
'description' => esc_html__( 'Action to initialize a test account.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'kyc_session' => array(
'type' => 'object',
'description' => esc_html__( 'Action to create or resume an embedded KYC session.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'kyc_session_finish' => array(
'type' => 'object',
'description' => esc_html__( 'Action to finish an embedded KYC session.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'kyc_fallback' => array(
'type' => 'object',
'description' => esc_html__( 'Action to use as a fallback when dealing with errors with the embedded KYC.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'context' => array(
'type' => 'object',
'description' => esc_html__( 'Various contextual data for the step to use.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'context' => array(
'type' => 'object',
'description' => esc_html__( 'Various contextual data for the onboarding process to use.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
);
return $schema;
}
/**
* Get the schema properties for an onboarding step action.
*
* @return array[] The schema properties for an onboarding step action.
*/
private function get_schema_properties_for_onboarding_step_action(): array {
return array(
'type' => array(
'type' => 'enum',
'description' => esc_html__( 'The action type to determine how to use the URL.', 'woocommerce' ),
'enum' => array( WooPaymentsService::ACTION_TYPE_REST, WooPaymentsService::ACTION_TYPE_REDIRECT ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to use for the action.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
);
}
}