Must contain a <payment:connectorName> to provide the connector name.

May contain any number of <payment:parameter> tags to provide connector-specific configuration values.

Any attribute that has no namespace and begins with param. is added as a parameter. The parameter name is the part of the attribute name following param..

Currently supports:

• Test - Test Processor

  Parameters:

  • errorChance (optional, defaults to 10)

    Percentage chance of some sort of error (during <payment:storeCreditCard>, <payment:payment>, <payment:capture>, and <payment:void>).

  • rejectionChance (optional, defaults to 20)

    Percentage chance of being rejected, otherwise accepted (during <payment:payment>).

• Payflow Pro - Payflow Pro XMLPay system

  Parameters:

  • user (required)

    If you set up one or more additional users on the account, this value is the ID of the user authorized to process transactions. If, however, you have not set up additional users on the account, user has the same value as vendor.

  • vendor (required)

    Your merchant login ID that you created when you registered for the Payflow Pro account. This value is case sensitive.

  • partner (required)

    The ID provided to you by the authorized PayPal Reseller who registered you for the Payflow Pro service. If you purchased your account directly from PayPal, use PayPal. This values is case-sensitive.

  • password (required)

    User's password (string)

• USAePay - USAePay

  Parameters:

  • postUrl (required)

    Sandbox: Use https://sandbox.usaepay.com/gate.php
    Production: Use https://www.usaepay.com/gate.php

  • key (required)

    The source key generated by the Source Editor.

    Configured in Control/Settings/Source Keys:
    Sandbox: https://sandbox.usaepay.com/console/sources
    Production: https://www.usaepay.com/console/sources

  • pin (optional)

    The source pin used for MD5 hash order verification. If not provided MD5 hash will not be performed.

    Configured in Control/Settings/Source Keys:
    Sandbox: https://sandbox.usaepay.com/console/sources
    Production: https://www.usaepay.com/console/sources

• Authorize.Net - Authorize.Net AIM system

  Parameters:

  • x_login (required)

    The merchant's unique API Login ID

  • x_tran_key (required)

    The merchant's unique Transaction Key

• Stripe - Stripe

  Parameters:

  • apiKey (required)

    The API secret key

    Obtain your secret key from https://dashboard.stripe.com/account/apikeys.

Must be nested in a <payment:useProcessor> tag.

Any number of parameters may be nested inside a <payment:useProcessor> tag; however, each parameter must have a unique name.

Must be nested in a <payment:useProcessor> tag.

The output of the tag is the bank-provided unique token that may be used later to initiate payments with the <payment:payment> tag (see <payment:creditCardGUID>).

<payment:useProcessor> must be called before using this tag.

The credit card details are provided through a set of tags nested within this tag. The specific tags required may be processor-specific, but the minimum set of nested tags will generally be:

• ! <payment:cardNumber> - The credit/debit card number
• ! Either <payment:expirationDate> or both <payment:expirationMonth> and <payment:expirationYear>:
  • ! <payment:expirationMonth> - The expiration month (1-12)
  • ! <payment:expirationYear> - The expiration year (either two or four digit format)
  • ! <payment:expirationDate> - The expiration date in either MM/YY or MM/YYYY format
• ! <payment:firstName> - The cardholder's first/given name
• ! <payment:lastName> - The cardholder's last/family name
• ! <payment:streetAddress1> - The billing street address (line 1)
• ! <payment:city> - The billing city
• ! <payment:countryCode> - The card holder's two-digit ISO 3166-1 alpha-2 country code

The complete list of possible nested tags:

• ! <payment:cardNumber> - The credit/debit card number
• ! <payment:expirationMonth> - The expiration month (1-12)
• ! <payment:expirationYear> - The expiration year (either two or four digit format)
• ! <payment:expirationDate> - The expiration date in either MM/YY or MM/YYYY format
• ? <payment:cardCode> - The CVV2 card security code (three or four digits)
• ! <payment:firstName> - The cardholder's first/given name
• ! <payment:lastName> - The cardholder's last/family name
• ? <payment:companyName> - The company name on the card
• ? <payment:email> - The email address of the customer
• ? <payment:phone> - The phone number of the customer
• ? <payment:fax> - The fax number of the customer
• ? <payment:customerId> - An application-supplied customer identifier
• ? <payment:customerTaxId> - The Social Security Number (SSN) or Employer Identification Number (EIN) of the customer
• ! <payment:streetAddress1> - The billing street address (line 1)
• ? <payment:streetAddress2> - The billing street address (line 2)
• ! <payment:city> - The billing city
• ? <payment:state> - The billing state/province/prefecture
• ? <payment:postalCode> - The billing ZIP/postal code
• ! <payment:countryCode> - The card holder's two-digit ISO 3166-1 alpha-2 country code
• ? <payment:comment> - Any user or merchant comments associated with this card

? indicates zero or one use allowed
! indicates exactly one use required

<payment:useProcessor> must be called before using this tag.

All parameters and results are handled through a set of nested tags. These tags are:

• ? <payment:orderNumber> - The application-specific unique order number
• ? <payment:currencyCode> - The 3-digit ISO 4217 currency code, defaults to USD
• ! <payment:amount> - The amount of the payment
• ? <payment:taxAmount> - The tax amount of the payment
• ? <payment:taxExempt> - A true or false flag if the customer is tax exempt, defaults to false
• ? <payment:shippingAmount> - The shipping amount of the payment
• ? <payment:dutyAmount> - The duty amount of the payment
• ? <payment:shippingAddress> - Provides the shipping details for the payment. Contains nested:
  • ? <payment:firstName> - The shipping recipient first/given name
  • ? <payment:lastName> - The shipping recipient last/family name
  • ? <payment:companyName> - The shipping recipient company name
  • ! <payment:streetAddress1> - The shipping street address (line 1)
  • ? <payment:streetAddress2> - The shipping street address (line 2)
  • ! <payment:city> - The shipping city
  • ? <payment:state> - The shipping state/province/prefecture
  • ? <payment:postalCode> - The shipping ZIP/postal code
  • ! <payment:countryCode> - The shipping two-digit ISO 3166-1 alpha-2 country code
• ? <payment:merchantEmail> - The email address of the merchant
• ? <payment:invoiceNumber> - The invoice number of this transaction
• ? <payment:purchaseOrderNumber> - The purchase order number of this transaction
• ? <payment:comment> - An application or user provided comment for this transaction
• ! <payment:creditCard> - Provides the credit card details. Contains nested:
  • ! Must contain one of the following, but not both:
    1. New card:
       • ! <payment:cardNumber> - The credit/debit card number
       • ! Either <payment:expirationDate> or both <payment:expirationMonth> and <payment:expirationYear>:
         • ! <payment:expirationMonth> - The expiration month (1-12)
         • ! <payment:expirationYear> - The expiration year (either two or four digit format)
         • ! <payment:expirationDate> - The expiration date in either MM/YY or MM/YYYY format
       • ? <payment:cardCode> - The CVV2 card security code (three or four digits)
    2. Stored card:
       • ! <payment:maskedCardNumber> - The masked (partial) credit/debit card number
       • ! <payment:creditCardGUID> - The token of a stored credit card
  • ! <payment:firstName> - The cardholder's first/given name
  • ! <payment:lastName> - The cardholder's last/family name
  • ? <payment:companyName> - The company name on the card
  • ? <payment:email> - The email address of the customer
  • ? <payment:phone> - The phone number of the customer
  • ? <payment:fax> - The fax number of the customer
  • ? <payment:customerId> - An application-supplied customer identifier
  • ? <payment:customerTaxId> - The Social Security Number (SSN) or Employer Identification Number (EIN) of the customer
  • ! <payment:streetAddress1> - The billing street address (line 1)
  • ? <payment:streetAddress2> - The billing street address (line 2)
  • ! <payment:city> - The billing city
  • ? <payment:state> - The billing state/province/prefecture
  • ? <payment:postalCode> - The billing ZIP/postal code
  • ! <payment:countryCode> - The card holder's two-digit ISO 3166-1 alpha-2 country code
  • ? <payment:comment> - Any user or merchant comments associated with this card
• ! <payment:process> - This is the point where the bank is contacted and the payment is processed.
• * <payment:error> - The body of this tag will be processed when there was any type of error processing the payment.
  • * <payment:getErrorReason> - Gets the reason for the error.
• * <payment:accepted> - The body of this tag will be processed when the payment was accepted (approved).
  • * <payment:getAuthorizationCode> - Gets the approval code, usually a six-character code. This may be displayed to the customer.
  • * <payment:getTransactionId> - Gets the per-processor unique transaction ID. This might also be available in error and rejected states - but this is processor dependent. It is only guaranteed to be available on an accepted transaction.
• * <payment:held> - The body of this tag will be processed when the payment has been held (pending some sort of review).
  • * <payment:getReviewReason> - Gets the reason for the hold.
• * <payment:rejected> - The body of this tag will be processed when the payment was rejected (declined).
  • * <payment:getRejectedReason> - Gets the reason for the rejection - to be displayed to the user.
• * <payment:getCvvResult> - Gets the CVV2 (card security code) verification result.
• * <payment:getAvsResult> - Gets the AVS (address verification system) result.

* indicates zero or more uses allowed
? indicates zero or one use allowed
! indicates exactly one use required

<payment:useProcessor> must be called before using this tag.

All parameters and results are handled through a set of nested tags. These tags are:

• ! <payment:transactionID> - The transaction ID to capture.
• ! <payment:process> - This is the point where the bank is contacted and the capture is processed.
• * <payment:error> - The body of this tag will be processed when there was any type of error processing the capture.
  • * <payment:getErrorReason> - Gets the reason for the error.
• * <payment:success> - The body of this tag will be processed when the capture was successful.

* indicates zero or more uses allowed
! indicates exactly one use required

When the payment was not captured, the void will always work.

When the payment was captured, the void may or may not work depending on processor and transaction status. For example, a captured transaction in an open batch may be voided in the Sage processor. When the void is not an option, a credit must be issued instead.

<payment:useProcessor> must be called before using this tag.

All parameters and results are handled through a set of nested tags. These tags are:

• ! <payment:transactionID> - The transaction ID to void.
• ! <payment:process> - This is the point where the bank is contacted and the void is processed.
• * <payment:error> - The body of this tag will be processed when there was any type of error processing the void.
  • * <payment:getErrorReason> - Gets the reason for the error.
• * <payment:success> - The body of this tag will be processed when the void was successful.

* indicates zero or more uses allowed
! indicates exactly one use required

Must be nested in a <payment:payment> tag.

Contains nested:

• ! Must contain one of the following, but not both:
  1. New card:
     • ! <payment:cardNumber> - The credit/debit card number
     • ! Either <payment:expirationDate> or both <payment:expirationMonth> and <payment:expirationYear>:
       • ! <payment:expirationMonth> - The expiration month (1-12)
       • ! <payment:expirationYear> - The expiration year (either two or four digit format)
       • ! <payment:expirationDate> - The expiration date in either MM/YY or MM/YYYY format
     • ? <payment:cardCode> - The CVV2 card security code (three or four digits)
  2. Stored card:
     • ! <payment:maskedCardNumber> - The masked (partial) credit/debit card number
     • ! <payment:creditCardGUID> - The token of a stored credit card
• ! <payment:firstName> - The cardholder's first/given name
• ! <payment:lastName> - The cardholder's last/family name
• ? <payment:companyName> - The company name on the card
• ? <payment:email> - The email address of the customer
• ? <payment:phone> - The phone number of the customer
• ? <payment:fax> - The fax number of the customer
• ? <payment:customerId> - An application-supplied customer identifier
• ? <payment:customerTaxId> - The Social Security Number (SSN) or Employer Identification Number (EIN) of the customer
• ! <payment:streetAddress1> - The billing street address (line 1)
• ? <payment:streetAddress2> - The billing street address (line 2)
• ! <payment:city> - The billing city
• ? <payment:state> - The billing state/province/prefecture
• ? <payment:postalCode> - The billing ZIP/postal code
• ! <payment:countryCode> - The card holder's two-digit ISO 3166-1 alpha-2 country code
• ? <payment:comment> - Any user or merchant comments associated with this card

? indicates zero or one use allowed
! indicates exactly one use required

Any non-numeric characters will be ignored.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be in the range 1 to 12.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

May be either a two-digit or four-digit year. If a two-digit year (or any number between 0 and 99), will be assumed to be in the current century.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be in the format MM/YY or MM/YYYY.

Month must be in the range 1 to 12.

Year may be either a two-digit or four-digit year. If a two-digit year (or any number between 0 and 99), will be assumed to be in the current century.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be nested in a <payment:storeCreditCard> or <payment:creditCard>.

Must be nested in a <payment:creditCard> tag.

See <payment:storeCreditCard> for storing cards.

Must be nested in a <payment:creditCard> tag.

Must be nested in a <payment:payment> tag.

Contains nested:

• ? <payment:firstName> - The shipping recipient first/given name
• ? <payment:lastName> - The shipping recipient last/family name
• ? <payment:companyName> - The shipping recipient company name
• ! <payment:streetAddress1> - The shipping street address (line 1)
• ? <payment:streetAddress2> - The shipping street address (line 2)
• ! <payment:city> - The shipping city
• ? <payment:state> - The shipping state/province/prefecture
• ? <payment:postalCode> - The shipping ZIP/postal code
• ! <payment:countryCode> - The shipping two-digit ISO 3166-1 alpha-2 country code

? indicates zero or one use allowed
! indicates exactly one use required

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be nested in either a <payment:storeCreditCard> or <payment:creditCard> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.

Must be nested in a <payment:storeCreditCard>, <payment:creditCard>, or <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be either true or false.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:capture> or <payment:void> tag.

Must be nested in a <payment:payment>, <payment:capture>, or <payment:void> tag.

May use <payment:getErrorReason> or ${payment:getErrorReason()} to get the reason for the error.

Must be nested in a <payment:payment>, <payment:capture>, or <payment:void> tag.

Must be nested in a <payment:payment>, <payment:capture>, or <payment:void> tag.

May use <payment:getAuthorizationCode> or ${payment:getAuthorizationCode()} to get the authorization code to display to the customer.

May use <payment:getTransactionId> or ${payment:getTransactionId()} to get the per-processor unique transaction ID.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

This is guaranteed to be available when the payment is accepted. When the transaction ID is required, only use inside a <payment:accepted> tag or when ${payment:isAccepted()}.

Depending on the processor, this may also be available within <payment:error> and <payment:rejected> tags (or when ${payment:isError()} or ${payment:isRejected()}).

Must be nested in a <payment:payment> tag.

May use <payment:getReviewReason> or ${payment:getReviewReason()} to get the reason for the hold.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

May use <payment:getRejectedReason> or ${payment:getRejectedReason()} to get the reason for the rejection to display to the customer.

Must be nested in a <payment:payment> tag.

Must be nested in a <payment:payment> tag.

The result value may or may not be available under various circumstances on a per-processor basis. However, if supported, it should generally be available within <payment:accepted>, <payment:rejected>, and <payment:held> tags (or when ${payment:isAccepted()}, ${payment:isRejected()}, or ${payment:isHeld()}).

Must be nested in a <payment:payment> tag.

The result value may or may not be available under various circumstances on a per-processor basis. However, if supported, it should generally be available within <payment:accepted>, <payment:rejected>, and <payment:held> tags (or when ${payment:isAccepted()}, ${payment:isRejected()}, or ${payment:isHeld()}).

Must be nested in a <payment:payment> tag.