How to use URL Parameters

The recommended option is to use the URL Tokens and NOT the URL Parameters option.

The URL Parameter options parameters in the URL to control the defaults and behaviour of the online checkout form. This can include which Merchant Facility and Payment Form are being used.

1. Example 1: Connect your payment form to your Merchant Facility

1.1. Locate your Merchant Facility record ID

1.2. Place your Merchant Facility record ID into your URL with the parameter

2. Example 2: Place default contact details into the form

2.2. Locate your Contact's record ID

2.3. Place the record ID with the parameter (cId) into your URL

Default values are shown in the payment form.

3. List of available URL Parameters

Untitled Document

URL Parameter

Notes

MP 

UT 

CO 

R

payMSetting=yyy

Where yyy is the record id for the Merchant Facility (if not specified, then first Merchant Facility that is primary and active is used)

Y

Y

Y

 

payMType=yyy

Where yyy is the record id for the Payment Form (if not specified, then primary for the Merchant Facility is used)
If using this option, you must also specify the payMSetting=yyy option as well.

Y

Y

Y

 

cId=yyy

Where yyy is the Contact Record Id. This is used to default in payment contact details.
If specified, will default name, address, phone, fax and email details.

Y

Y

Y

 

aId=yyy

Where yyy is the Account Record Id. Used to link the payment with an account.
If specified, will default Donation_By_Name, address details and phone/fax details from the account values.

Y

Y

Y

 

oppId=yyy

Where yyy is Opportunity Id. Used to link the payment with an existing Opportunity.

Y

Y

Y

 

shoppingCartDetails=yyy

Where yyy is a JSON string of shopping cart line items so they can appear on receipthttp://www.payments2us.com/user-manual/other/how-to-use-shoppingcartdetails-url-parameter/

N

N

Y

 

camId=yyy

Where yyy is Campaign Id. Used to link the payment with an existing Campaign.

Note, the default campaign on the Payment Form will be assigned to the transaction if appeals are enabled.

Y

Y

Y

 

paymentOptionId=yyyy

Id of a particular payment option, eg. Family membership, or perhaps a product.

Y

Y

Y

 

paymentOptionIdReadOnly=true

Normally used in conjunction with PaymentOptionId. Using this parameter allows for the payment option to be pre-selected and shown, but does not allow the user to change the defaulted parameter

Y

Y

Y

 

HidePayFrequency=true

Hides the Payment Frequency selection on the screen. This is useful when only one payment frequency is selected and therefore the user only has one option.

 

Y

Y

 

HideProgressBar=true

Hides the progress bar at the top of the checkout form. This defaults to true for Modern Form and false for Classic Form.

 

 

Y

 

PayFrequency=yyyyy

Defaults/specifies the payment frequency

Y

Y

Y

 

Amount=yyy

Where yyy is a payment amount. This is normally used if the payment form is access as a “checkout” or linked to another object/function. If specified, the amount is shown as is read only.

Amount value is ignored if used in conjunction with paymentOptionId.

Y

Y

Y

Y

defaultAmount=yyyy

Where yyyy is the payment amount. This varies from amount in that the user can then override the defaulted amount

Y

Y

Y

 

donationAmount=yyyy

Where yyyy is the donation amount.

Y

Y

Y

 

FreightAmount=yyyy

The amount to be used for Freight.

Y

Y

Y

 

customRefFieldName=yyy

Used in conjunction with customRefFieldId. Allows for a new custom lookup field to be added to payment transactions and to be linked to this object. Ie. Making payments for custom object.

This is a lookup field on the Payment_Txn__c object to the custom object, eg. Mycustomobject__c (if this was Payment_Txn__c.Mycustomobject__c).

Y

Y

*

 

customRefFieldId=yyy

Used in conjunction with customRefFieldName.

This is the record id of the custom object.

Eg. customRefFieldName= Mycustomobject__c& customRefFieldId= a04A000000Ctj9g

Y

Y

*

 

customField[1,2,3]Name

Used in conjunction with customField[1,2,3]Value. Allows for 3 different custom fields to be updated by URL value passed in a URL parameter. For the name specify a non-managed custom field as setup in salesforce.com. Eg. customField 1Name=My_field__c

Y

Y

*

 

customField[1,2,3]Value

Used in conjunction with customField[1,2,3]Name. Allows for 3 different custom fields to be updated by URL value passed in a URL parameter.
Eg. customField1Value=Sydney

Y

Y

*

 

HideContactDetails=true

Hide's the Contact Name and Address section. Normally used when all name/address info are passed as URL parameters.

Y

Y

Y

 

HideTransDetails=true

If “true” then the "Transaction \ Details" on the payment form will be hidden. Normally used in conjunction with Amount parameter, or if the only field shown in this section is the amount.

 

Y

Y

 

hidePaymentOverview=true

Enables the main text at the top of the payment form to be hidden. This is a useful option when used with events.

 

Y

Y

 

hidePaymentNote=true

Hides the text at the bottom of the checkout form.

 

Y

Y

 

hideCampaignOverview=true

Hides the Campaign Overview on the checkout form. The Campaign Overview text appears if Payment Overview text is entered on a Campaign and that campaign is linked to the checkout form.

 

Y

Y

 

paymentFor=yyy

Description of what the payment is for. Normally used if passed to gateway, eg. short description of goods or service. If not specified will be defaulted from campaign or payment method.

Y

Y

Y

 

PaymentBy=yyy

This will set the payment by on the \ form. The value entered must equal one of the options on the Payment Form - Donation by options, for example, Individual, Company etc.

Y

Y

Y

 

PaymentByName=yyy

Normally used in conjunction with PaymentBy. Would mainly be used to pass company name information in.

Y

Y

Y

 

Currency=yyy

Where yyy is an ISO currency. The currency needs to be setup in the Merchant Facility Currency options before using.

Y

Y

Y

 

lang=yyyy

Where yyy is the ISO Language, eg. fr,de \ (for French, German)

Y

N

Y

Y

retURL=yyy

Where yyy is the URL location to be returned too after save

Y

N

N

N

AllowManualExternal=true This option is used in conjunction with Payment Method of Manual. If selected, the manual option will also be available on the public website. Otherwise, the Manual Option is only available for internal (Logged in Salesforce users) N Y Y N
ExpiryDateDisplay=[FreeForm] (Options: FreeForm, Picklist,{blank}) Options to change how this is displayed. If FreeForm, then this will be normal input box. This is useful if using on mobile devices such as iPhones and Card Scan features need to be used. N Y Y N

Salutation=yyy
FirstName=yyy
LastName=yyy
MailingStreet=yyy
MailingState=yyy
MailingCity=yyy
MailingPostalCode=yyy
MailingCountry=yyy
Phone=yyy
MobilePhone=yyy
Email=yyy
MembershipId=yyy

All of these fields can be defaulted a value.

Y

Y

Y

 

 

There are a number of parameters that can be passed to the payment form through the URL.  The table aboves lists these parameters

Key shows which screen these options are available in:

  • MP: Manual Payments
  • UT: URL Tokens are available.  The option is available in manual payments or checkout when MP or CO parameter’s are available.
  • CO: Available in Checkout
  • R: Refund
  • * Custom fields are available in URL Tokens.  Create a custom field with the same name using the standard salesforce custom fields functionality.