Interface PaymentGatewaysHelper

fx:property_helpers: PropertyHelpers

self: PaymentGatewaysHelper

message: string

values: {}

• [key: string]: { additional_fields: null | { blocks: { fields: { default_value: string; description?: string; id: string; name: string; options?: { name: string; value: string }[]; type: string }[]; id: string; is_live: boolean; parent_id: string }[] }; card_verification: "disabled" | "enabled_automatically" | "enabled_override"; card_verification_config: string; id_description: string; is_deprecated: boolean; key_description: string; name: string; supports_3d_secure: 0 | 1; supports_auth_only: 0 | 1; supports_card_verification: boolean; test_id: string; test_key: string; test_third_party_key: string; third_party_key_description: string }

  • additional_fields: null | { blocks: { fields: { default_value: string; description?: string; id: string; name: string; options?: { name: string; value: string }[]; type: string }[]; id: string; is_live: boolean; parent_id: string }[] }

    If this gateway requires additional information, this will contain details about the data which needs to be collected to configure this gateway.

  • card_verification: "disabled" | "enabled_automatically" | "enabled_override"

    Default card verification mode if this gateway supports it.

  • card_verification_config: string

    Default configuration for card verification amounts. This is a serialized JSON string that contains the amounts for each card type. Example: {"verification_amounts": {"visa": 1, "mastercard": 1, "american_express": 1, "discover": 1, "default": 1}}.

  • id_description: string

    The description of the id field for this gateway.

  • is_deprecated: boolean

    Marks payment gateways that are no longer supported.

  • key_description: string

    The description of the key field for this gateway.

  • name: string

    The name of this payment gateway.

  • supports_3d_secure: 0 | 1

    Whether or not this gateway supports 3D Secure functionality.

  • supports_auth_only: 0 | 1

    Whether or not this gateway supports authorize only instead of auth+capture.

  • supports_card_verification: boolean

    Whether or not this gateway supports card verification.

  • test_id: string

    The default id you can use for testing this gateway.

  • test_key: string

    The default key you can use for testing this gateway.

  • test_third_party_key: string

    The default third party key you can use for testing this gateway.

  • third_party_key_description: string

    The description of the third party key field for this gateway.