Automattic\WooCommerce\Internal\Admin\Settings
PaymentsRestController::get_schema_for_payment_provider │ private │ WC 1.0
Get the schema for a payment provider.
Method of the class: PaymentsRestController{}
No Hooks.
Returns
Array. The schema for a payment provider.
Usage
// private - for code of main (parent) class only $result = $this->get_schema_for_payment_provider(): array;
PaymentsRestController::get_schema_for_payment_provider() PaymentsRestController::get schema for payment provider code WC 9.9.3
private function get_schema_for_payment_provider(): array {
return array(
'type' => 'object',
'description' => esc_html__( 'A payment provider in the context of the main Payments Settings page list.', 'woocommerce' ),
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_order' => array(
'type' => 'integer',
'description' => esc_html__( 'The sort order of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of payment provider. Use this to differentiate between the various items in the list and determine their intended use.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'type' => 'string',
'description' => esc_html__( 'The title of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'type' => 'string',
'description' => esc_html__( 'The description of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'supports' => array(
'description' => esc_html__( 'Supported features for this provider.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
),
),
'plugin' => array(
'type' => 'object',
'description' => esc_html__( 'The corresponding plugin details of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'_type' => array(
'type' => 'string',
'enum' => array(
PaymentProviders::EXTENSION_TYPE_WPORG,
PaymentProviders::EXTENSION_TYPE_MU_PLUGIN,
PaymentProviders::EXTENSION_TYPE_THEME,
PaymentProviders::EXTENSION_TYPE_UNKNOWN,
),
'description' => esc_html__( 'The type of the containing entity. Generally this is a regular plugin but it can also be a non-standard entity like a theme or a must-user plugin.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'type' => 'string',
'description' => esc_html__( 'The slug of the containing entity.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'file' => array(
'type' => 'string',
'description' => esc_html__( 'The plugin main file. This is a relative path to the plugins directory.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'status' => array(
'type' => 'string',
'enum' => array(
PaymentProviders::EXTENSION_NOT_INSTALLED,
PaymentProviders::EXTENSION_INSTALLED,
PaymentProviders::EXTENSION_ACTIVE,
),
'description' => esc_html__( 'The status of the containing entity.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'image' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the provider image.', 'woocommerce' ),
'readonly' => true,
),
'icon' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the provider icon (square aspect ratio - 72px by 72px).', 'woocommerce' ),
'readonly' => true,
),
'links' => array(
'type' => 'array',
'description' => esc_html__( 'Links for the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'_type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of the link.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'url' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the link.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'state' => array(
'type' => 'object',
'description' => esc_html__( 'The general state of the provider with regards to it\'s payments processing.', 'woocommerce' ),
'properties' => array(
'enabled' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider is enabled for use on checkout.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'account_connected' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider has a payments processing account connected.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'needs_setup' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider needs setup.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'test_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider is in test mode for payments processing.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'dev_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider is in dev mode. Having this true usually leads to forcing test payments. ', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'management' => array(
'type' => 'object',
'description' => esc_html__( 'The management details of the provider.', 'woocommerce' ),
'properties' => array(
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'settings' => array(
'type' => 'object',
'description' => esc_html__( 'The link to the settings page for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to the settings page for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
),
),
'onboarding' => array(
'type' => 'object',
'description' => esc_html__( 'Onboarding-related details for the provider.', 'woocommerce' ),
'properties' => array(
'type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of onboarding process the provider supports.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'state' => array(
'type' => 'object',
'description' => esc_html__( 'The state of the onboarding process.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
),
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'preload' => array(
'type' => 'object',
'description' => esc_html__( 'The onboarding preload link for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to do onboarding preload for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'onboard' => array(
'type' => 'object',
'description' => esc_html__( 'The start/continue onboarding link for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to start/continue onboarding for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
'recommended_payment_methods' => array(
'type' => 'array',
'description' => esc_html__( 'The list of recommended payment methods details for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'description' => esc_html__( 'The details for a recommended payment method.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the payment method.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_order' => array(
'type' => 'integer',
'description' => esc_html__( 'The sort order of the payment method.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'enabled' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the payment method should be recommended as enabled or not.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'required' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the payment method should be required (and force-enabled) or not.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'type' => 'string',
'description' => esc_html__( 'The title of the payment method. Does not include HTML tags.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'type' => 'string',
'description' => esc_html__( 'The description of the payment method. It can contain basic HTML.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'icon' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the payment method icon or a base64-encoded SVG image.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
),
'tags' => array(
'type' => 'array',
'description' => esc_html__( 'The tags associated with the provider.', 'woocommerce' ),
'uniqueItems' => true,
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
'description' => esc_html__( 'Tag associated with the provider.', 'woocommerce' ),
'readonly' => true,
),
),
'_suggestion_id' => array(
'type' => 'string',
'description' => esc_html__( 'The suggestion ID matching this provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_incentive' => $this->get_schema_for_incentive(),
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'attach' => array(
'type' => 'object',
'description' => esc_html__( 'The link to mark the suggestion as attached. This should be called when an extension is installed.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to attach the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'hide' => array(
'type' => 'object',
'description' => esc_html__( 'The link to hide the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to hide the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
),
);
}