Smartsite Documentatie > SXML > Macro > Payment Macro
SCAS Level
This module allows integration of Ogone e-Commerce in a Smartsite iXperion site.

Syntax

Smartsite SXML CopyCode image Copy Code 
<se:payment>
    <se:parameters>
        <se:parameter name="checkoutname">
            
        </se:parameter>
    </se:parameters>
</se:payment>

Parameters

Name Data Type Properties Description
Amount Float - Sets the amount.
AutoIncrementSerial Boolean - Sets a value indicating whether to increment the serial automatically. If one or more failed attempts were already registered, the module will increment the serial automatically.
Brand String - Sets the brand of the payment method.
CatalogUrl Locator - Sets the URL to the catalog page. The Payment page will display this link as a button.
CheckoutName String IsRequired
Sets the name of the checkout to use for payment. Checkouts can be configured in Smartsite.Ogone.config.
Currency String - Sets the currency using ISO 4217 codes.
CustomerAddress String - Sets the customer address.
CustomerCountry String - Sets the customer country.
CustomerEmail String - Sets the customer email address.
CustomerName String - Sets the name of the customer.
CustomerPhone String - Sets the customer phone number.
CustomerTown String - Sets the customer town.
CustomerZipcode String - Sets the customer zipcode.
ExtraData String - Sets the extra data. Will be sent with the request to Ogone.
ForceEncoding Boolean - The Payment module sets the response encoding to ISO-8859-1 for the page containing the payment form to make sure Internet Explorer posts the correct data to Ogone. Disable this behaviour by setting ForceEncoding to false.
HomeUrl Locator - Sets the home URL of the current site. The Payment page will display this link as a button. Defaults to the Website address setting in the Ogone account/Administrative details settings.
Mode Enum - Sets the mode of the payment module.
Enum values:
  • form
    Shows the payment form
  • callback
    Handles the server to server callback from Ogone
OrderId String - Sets the order id.
PaymentMethod String - Sets the payment method.
Serial Integer - Sets the serial for the payment attempt. Will be combined with the OrderId to have a unique identifier for multiple attempts.
SubmitCaption String - Sets the caption for the submit button.

Shared Parameters

Name Data Type Properties Description
Access String - Friendly name of the minimum access type level required by the site visitor to execute this macro.
AccessDenied String RawData
Sets the value that is returned when the site visitor has insufficient access.
AIM Enum - Sets the AIM scanning mode of the macro.
Enum values:
  • NotSet
    Not set.
  • Off
    No AIM scanning.
  • External
    Output XML scanning.
  • Internal
    Internal scanning, implemented by AIM-aware macros.
  • Autonomous
    Relations are to be linked to the current source item, instead of the rendered page.
  • SoftLink
    Should generate soft links (in combination with External flag).
  • InternalAutonomous
    Internal scanning, combined with the Autonomous setting.
  • ExternalAutonomous
    External scanning, combined with the Autonomous setting.
  • ExternalAutonomousSoftLink
    External scanning, combined with the Autonomous and softLink settings.
  • ExternalSoftLink
    External scanning, combined with the Softlink setting.
Condition String MustBeAttribute
ExpressionSyntax
XmlDecode
Sets the Viper expression to evaluate before actually executing the macro.
If the expression returns false, the execution of the module and its child modules is skipped.
Default String RawData
Sets the default value that will be returned when the execution would otherwise return an empty string.
Error String RawData
Sets the value to return in case on error occurs during execution.
The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
Id String MustBeAttribute
Trim
Sets the Id of the macro. Macros with Ids set can be accessed using Viper by referring to page.[id].[methodname()].
LocalId String MustBeAttribute
Trim
Sets the local id of the macro in the current buffer scope.
Rem String RawData
NoCache
Trim
Sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
ResultFormat String RawData
Sets the resultformat.
ResultType Enum - Sets the type of the result.
Enum values:
  • Undefined
    Not set
  • None
    No result
  • String
    Default type
  • Object
    Generic object
  • Binary
    Binary data
  • Boolean
    Boolean
  • DataTable
    DataTable
  • DateTime
    Date/time
  • Float
    Floating point numeric data
  • Integer
    Integer
  • Locator
    Extended Uri
  • Xml
    Xml Data
Save Collection - Sets the buffer names.
Status Enum - Gets a value indicating the ModuleStatus of this module.
Enum values:
  • Unknown
    Unknown
  • BeginInitialize
    Initializing the module
  • EndInitialize
    Module has fully initialized
  • BeginSetProperties
    Properties are about to be set
  • EndSetProperties
    Properties have been set
  • BeginExecute
    Execution starts
  • BeginFormatData
    Starting data formatting.
  • EndFormatData
    Ended data formatting.
  • BeginFormatResult
    Before formating result.
  • EndFormatResult
    After formatting result
  • EndExecute
    Execution is ending
  • StartLoseScope
    Execution has completed
  • EndLoseScope
    Module is about to unload
  • Error
    Module is in an error state
Timeout Float - Sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
Trim Enum MustBeAttribute
Gets a value indicating how the whitespace is trimmed.
Whitespace Enum MustBeAttribute
Gets a value indicating whether to preserve whitespace.
Enum values:
  • Inherit
    Inherit from parent.
  • Preserve
    Keep all whitespace.
  • Remove
    Remove all whitespace.
  • Normalize
    Convert all whitespace to single spaces.
  • SimpleFormat
    Convert all whitespace to single spaces, but keep single line breaks.

Local Viper Methods

Viper Extension Description
This.Amount   Gets the amount.
This.Brand   Gets the brand of the payment method.
This.ClearForcedResult   Sets the result of the macro.
used to override the normal handling of the result creation.
This.Currency   Gets the currency using ISO 4217 codes.
This.CustomerAddress   Gets the customer address.
This.CustomerCountry   Gets the customer country.
This.CustomerEmail   Gets the customer email address.
This.CustomerName   Gets the name of the customer.
This.CustomerPhone   Gets the customer phone number.
This.CustomerTown   Gets the customer town.
This.CustomerZipcode   Gets the customer zipcode.
This.ExtraData   Gets the extra data. Will be sent with the request to Ogone.
This.GetForcedResult   Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
This.OrderId   Gets the order id.
This.PaymentMethod   Gets the payment method.
This.Redirect   Gets the redirect for the current payment.
This.RenderTime ✓ Returns the render time of the macro in milliseconds.
This.Serial   Gets the serial for the payment attempt. Will be combined with the OrderId to have a unique identifier for multiple attempts.
This.SetForcedResult   Sets the result of the macro.
used to override the normal handling of the result creation.
This.Status   Gets the status of the current payment.
This.Summary   Gets the summary of the current payment.

Shared Local Viper Methods

Viper Extension Description
This.AIM.Relations ✓ Gets a list of all outgoing AIM relations created by the macro.
This.Buffer.Exists   Checks whether a local buffer exists.
This.Buffer.Get   Gets a local buffer.
This.Buffer.Set   Sets a local buffer.
This.Error.InnerException.Message   Returns the text message of the inner exception of the exception that has occurred.
This.Error.InnerException.SmartsiteCode   Returns Smartsite error code of the inner exception of the exception that has occurred.
This.Error.InnerException.Throw   Makes Smartsite throw the inner exception.
This.Error.InnerException.ToString   Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
This.Error.InnerException.Type   Returns the full Type name of the inner exception of the exception that has occurred.
This.Error.Message   Returns the text message of the exception that has occurred.
This.Error.SmartsiteCode   Returns the Smartsite Error code of the exception that has occurred.
This.Error.Throw   Makes Smartsite throw the current exception.
This.Error.ToString   Returns the full information of the exception that has occurred, including the stack trace.
This.Error.Type   Returns the full Type name of the exception that has occurred.
This.FindExtension   Finds an extension macro.
This.GetParameter ✓ Gets the value of the given parameter/property.
This.ParameterExists ✓ Checks whether the given parameter/property is set.
This.Result   Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
This.SXMLPath   Gets the path to the macro in the current execution stack.
SXML