Checkout

Simple & Secure


Offload the burden of hosting your own payment form and reduce your PCI scope with Forte's third-generation Checkout. Checkout's advanced features enable you to make quick and painless payments on your own site with just a few lines of code.

With Checkout you get

  • A simple integration
    Start using Checkout today with customizable JavaScript that sits on top of your existing site.
  • Wallet storage functionality
    Save customers and their payment methods to make checking out fast and easy.
  • Up-to-date customer data
    Enable customers to edit their own address and payment data to ensure you always have the correct information.
  • Advanced form field settings
    Default Checkout's form fields to a value, empty, or hidden for full control over the data collected.
  • Granular amount settings
    Specify a non-editable amount to pay or a range of amounts for the customer.
  • Reduced cart abandonment
    Ensure your customer's trust by running the entire checkout process from your site.

Checkout’s Pay Now button uses an HTML form POST action with a signature to create the modal window. When the user clicks the button with coded parameters on the client side, Forte servers read the parameters and populate the modal window. The JavaScript, https://checkout.forte.net/v1/js, includes a Forte name-spaced version of jQuery so as not to conflict with other client-side jQuery code.

Checkout supports the three previous versions of the following browsers on a rolling basis:

Each time a new version of one of these browsers is released, Checkout begins supporting it and continues to support the previous two versions (and only the previous two). For example, Checkout currently supports versions 9, 10, and 11 of IE; however, if and when Microsoft releases version 12, Checkout will support versions 10, 11, and 12 and will no longer support version 9. NOTE: Checkout only works in IE's Standard view; the Checkout modal will not display in Compatibility view. For information on how to turn off IE's Compatibility view, see the Troubleshooting FAQs for more information.

This compatibility standard enables Checkout to use the latest and greatest security and performance features of the newest, most up-to-date browsers.

Before coding the Pay Now button, merchants must set up a test account and perform the following tasks in the Virtual Terminal application:

  • Generate an API Login ID
  • Generate a Secure Transaction Key

 

Only these values are required for Checkout. The Secure Web Pay configuration options do not affect Checkout.

 

Generating Keys

Requests to Checkout require a hashed signature for authentication. This signature contains the merchant's unique API Login ID. The Secure Transaction Key is a private key that the Merchant uses when hashing signed elements. For security, the Secure Transaction Key must be kept safe. For more information on creating a hash signature, see Authentication.

Complete the following steps to generate your API Login ID and Secure Transaction Key:

  1. Log into your Virtual Terminal Account.
  2. Navigate to the Gateway Settings tab and click the Gateway Key icon (). The following screen displays:


  3. Click next to the API Login ID field. The application generates a new value.
  4. Click next to the Secure Transaction Key field. The application generates a new value.
  5. Record both of these newly generated values in a secure location to use in authenticating your Checkout requests.
  6. Click to save these values to your merchant account.

NOTE: Once you save your Secure Transaction Key, you will not be able to see the values again.


Checkout uses hash signatures for authentication.

 

Creating a Signature

The example below displays what information your signature should contain:

HMACMD5("api_login_id|method|version_number|total_amount|utc_time|order_number|customer_token|paymethod_token",
"Secure Transaction Key")

Use the following parameters when creating your hash signature:

ParameterDescriptionType
api_login_idThe merchant-specific API Login ID that you created in the Virtual Terminal. See Merchant Configuration for information on creating this value.string
method

Supported types include the following:

  • sale
  • schedule
  • token
  • auth
string
version_number

1.0

string
total_amountA string that represents the total amount of the transaction. string
utc_time

A date-time value (since 01/01/0001 00:00:00) that marks the day and time the request was sent to Checkout in ticks. Requests expire after a certain length of time to prevent malicious users from capturing requests and resubmitting them at a later time.

Checkout provides an API that returns the correct UTC time from Forte’s server. Using this server-side value prevents inadvertent expiration errors from client PCs that do not have the correct local time set.

Use the following getUTC API URLs in your code to retrieve UTC ticks from Forte's servers:

  • https://sandbox.forte.net/checkout/getUTC?callback=? for the sandbox environment
  • https://checkout.forte.net/getUTC?callback=? for the live environment

The following script returns the correct UTC time for the hash:

<script>
  var button = $('button[api_login_ID]');
  $.getJSON('https://sandbox.forte.net/checkout/getUTC?callback=?').done(function (utc) {
  button.attr('utc_time', utc);
  });
  </script>
string
order_numberA string that represents the order number associated with a transaction.string
customer_tokenAn alphanumeric ID used to reference a customer. Forte stores the token and its associated information.string
paymethod_tokenAn alphanumeric ID used to reference stored payment information (card or eCheck) for a customer. Forte stores the token and its associated information.string

 

Send the hashed values in signature parameter, a character string of varying length (depending on the hash method) that is used to represent a specific transaction for a specific merchant in Forte Checkout.


Sample String

The following sections displays sample strings that will be hashed and their button attributes.

 

Single Amount

"9ZqZgNyTHX|sale|1.0|10.00|635297928450733746|A1234||";
<button api_login_id="9zqzgNyTHX"
         method="sale"
         version_number="1.0"
         utc_time="635297928450733746" 
         hash_method="md5"
         signature="f1fa83c9945b2302d80c9271ea847b52"
         callback="oncallback"
         total_amount="10.00"
         order_number="A1234">
         Pay Now</button>

 

Scheduled, Ranged Amount

"9ZqZgNyTHX|schedule|1.0|1-9.5;5|635297928450733746|A1234|1000833|1001239";
<button api_login_id="apiloginid"
         method="schedule"
         customer_token="1000833"
         paymethod_token="1001239"
         version_number="1.0"
         utc_time="635297928450733746"
         hash_method="md5"
         signature="ec34595fb2ecb0bfa40de2722744e6af"
         callback="oncallback"
         total_amount="1-9.5;5"
         schedule_start_date="1/1/2015"
         schedule_frequency="weekly"
         schedule_quantity="12"
         schedule_continuous="false"
         order number="A1234">
      Subscribe</button>

 

Selection Amount

"9ZqZgNyTHX|sale|1.0|{20,40,60,80,100,0};20|635297928450733746|||";
<button api_login_id="9zqzgNyTHX"
         method="sale"
         version_number="1.0"
         utc_time="635297928450733746"
         hash_method="md5"
         signature="ccf46549a5c37d23a83a5dbb8f851187"
         callback="oncallback"
         total_amount="{20,40,60,80,100,0};20>"
      Select Amount</button>

 

Ranged Selection Amount with Labels

"9ZqZgNyTHX|sale|1.0|{1375.23,1573.66,56.99,0|Total outstanding,Last statement balance,Minimum balance,Specify different amount}|635297928450733746|||";
<button api_login_id="9zqzgNyTHX"
         method="sale"
         version_number="1.0"
         utc_time="635297928450733746"
         hash_method="md5"
         signature="d8f671ac6fafcb25996b27203dffc513"
         callback="oncallback"
         total_amount="{1375.23,1573.66,56.99,0|Total Outstanding,Last Statement,Minimum Balance,Specify Different Amount}">
      Select Amount with Labels</button>

To create the Pay Now button for your site, you will first need to generate your API Login ID and Secure Transaction Key in the Virtual Terminal (see Merchant Configuration).

 

Endpoints

The following scripts invoke Checkout and should be placed in the <head> section of your website:

  • https://sandbox.forte.net/checkout/v1/js for sandbox testing
  • https://checkout.forte.net/v1/js for production

 

Customizing the Button

The code below represents the minimal html code required to generate a payment button. If you want Checkout to capture additional information, such as a customer's shipping address, you must include the additional parameters listed below.

<!DOCTYPE html>
	<script type="text/javascript" src="https://sandbox.forte.net/checkout/v1/js"></script>
	<button api_login_id="apiloginid"
		method="sale"
		version_number="1.0"
		utc_time="UTCtime"
		order_number="ASX458956"
		signature="md5signature">
	   Pay Now</button>

 

Parameters

ParameterDescriptionDefaultAttributesLengthType
General Parameters
method

Supported types for this required parameter include the following:

  • sale - creates an ad-hoc transaction
  • schedule - used to schedule a single, future-dated transaction or create a schedule
    of recurring transactions. NOTE: When creating a schedule, client and payment tokens
    are automatically returned.
  • token - creates both customer and paymethod tokens or generates a new paymethod token for an existing customer. No transaction is generated.
  • auth - authorizes the paymethod
saleN8string
allowed_methods

Supported types include the following:

  • visa
  • mast
  • amex
  • dine
  • jcb
  • disc
  • echeck

(e.g., allowed_methods = visa, mast, disc, amex, echeck passed as a comma-delimited string)

N6string
hash_method

Supported values include the following:

md5N6string
version_number

1.0

1.0N4string
total_amount

See Configuring Amounts for information on coding these
values.

Amount Configurations can include the following options:

  • Single amounts
  • Range of amounts
  • Choice of amounts
  • Amount choices with a default amount displayed
  • Amount selections with a ranged amount displayed
  • Amount selections with descriptive text next to each
    displayed amount
  • Amount selections with descriptive text and a ranged
    amount

NOTE: The value of the total_amount parameter must be greater than zero.

Ystring
order_numberA string that represents the order number associated with a
transaction.
Nstring
save_token

Use one of the following values for this parameter:

  1. true = If the transaction completes, Checkout
    will create and save both customer and payment
    method tokens
  2. false = Checkout will not create and save the
    customer or payment method tokens
  3. NOTE: For scheduled transaction, the merchant
    must pass predefined customer and/or payment tokens
    or set save_token=true.

falseNbool
customer_tokenAn alphanumeric ID used to reference a customer. Checkout will create an integer value for this parameter.N36string
paymethod_tokenAn alphanumeric ID used to reference stored payment information (card or eCheck) for a customer. Checkout will create an integer value for this parameter.N36string
collect_shipping_address

Use one of the following values for this parameter:

  1. true = Checkout collects the shipping address from
    the customer
  2. false = No shipping entry is allowed
falseNbool
entered_byName of the user entering the transaction.N25string
swipe

Use one of the following values for this parameter:

  1. true = Checkout will detect the supported swipe terminal
    and allow the customer to use it.
  2. false = The merchant must manually enter the card information into Forte Checkout.
falseNbool
button_text

Enables the user to customize the text of the payment button. If the user does not pass a value in this parameter, Checkout reverts to the following default values according to themethodof the transaction:

sale/auth/schedule = Authorize

token = Create Token

AuthorizeNstring
expire_utcEnables the merchant to define a UTC expiration date-time value for the transaction in ticks. If the customer attempts a transaction after this set time has expired, Checkout's modal automatically closes and he or she must generate a new Checkout form. NOTE: This parameter only applies to the sale and schedule methods.Nstring
xdata_#Up to nine fields (1–9) of extra data that you can associate with a schedule or a transaction. Each field can contain up to 80 characters. This data does not display on the Checkout modal window; however, the merchant can join this information to the webhook response to provide a more detailed description of the transaction. NOTE: Values within this field cannot contain double quotation characters (i.e., "text"); Forte Checkout supports single quotation characters (i.e., 'text'). If you require double quotation characters within this value, use HTML escape characters to ensure the information properly displays (e.g., xdata_1="Marco's &#147;Place&#148;").N80string
line_item_1-100Up to 100 available fields of line items that a merchant can display to their customer (e.g., name, quantity, price, etc.). This data does not display on the Checkout modal window and is not returned in the callback/webhook; however, the merchant can join this information to the webhook response to provide a more detailed description of the transaction.Nstring
line_item_headerA brief header field that precedes the line_item data field.Nstring
Billing Parameters
billing_nameBilling name of the customerY50string
billing_company_nameBilling name of the customer's companyY50string
billing_street_line1Street address of the customer's billing informationY35string
billing_street_line2Additional line of street address information, such as Suite or Apartment numberY35string
billing_localityLocality/city/town/village of the customer's billing addressY25string
billing_regionRegion/state/province of the customer's billing address.Y10string
billing_postal_codePostal/zip code of the customer's billing addressY15string
billing_countryCountry code of the customer's billing address (includes military states)Y2string
billing_email_addressThe customer's billing email addressY50string
billing_phone_numberThe customer's billing phone numberY15string
Shipping Parameters
shipping_nameShipping name of the customerY50string
shipping_company_name

Shipping name of the customer's company

NOTE: This parameter is not part of the transaction and is not displayed in any transaction detail; rather, it is merely stored as part of the address record. You can access this information via Checkout or the addressresource in Forte's web services.

Y50string
shipping_street_line1Street address of the customer's shipping informationY35string
shipping_street_line2Additional line of street address information, such as Suite or Apartment numberY35string
shipping_localityLocality/city/town/village of the customer's shipping addressY25string
shipping_regionRegion/state/province of the customer's shipping addressY10string
shipping_postal_codePostal/zip code of the customer's shipping addressY15string
shipping_countryCountry code of the customer's shipping address (includes military states)Y2string
shipping_email_addressThe customer's shipping email addressY50string
shipping_phone_numberThe customer's shipping phone numberY15string
Scheduling Parameters
schedule_start_dateIndicates the start date of the next recurring transaction in
MM/DD/YYYY format. This date can be today's date or
greater.
Y10string
schedule_frequency

Indicates the frequency of the charges:

  • weekly
  • bi-weekly (i.e., every 14 days)
  • monthly
  • bi-monthly(i.e., every two months)
  • quarterly (i.e., every three months)
  • semi-annually
  • annually

Set this parameter to "0" for a single, future transaction

Y12string
schedule_quantityIndicates the quantity of transactions to perform. Set to "0"
for a single future transaction.
Y3int
schedule_continuous
  1. true = This transaction schedule will be continuous
  2. false = This transaction schedule will not be
    continuous
falseY5string

 

NOTE:

  • Scheduling parameters require the merchant to pass predefined customer and payment tokens or set save_token=true.
  • When passing a customer token or creating a schedule, the shipping address can only be edited; a new address cannot be added.

 

Attributes

To make these parameters editable, required, or hidden, pass the parameter suffixed with attr and one or more of the following attributes:

AttributeDescriptionExample
editMakes the field editable for the user
  1. billing_name_attr="edit"
  2. billing_name_attr="edit,required"
requiredMakes the field required
  1. billing_postal_code_attr="required"
  2. billing_postal_code_attr="edit,required"
hideHides the field from the user; however, Checkout passes the parameter with the transaction behind the scenes. This attribute cannot be combined with the "edit" or "required" attributes.

billing_name_attr="hide"

Checkout supports a number of different amount configurations including the following:

  • Single Amount greater than zero
    • The merchant specifies the amount
    • The customer specifies the amount
  • Ranged Amount
    • The customer must enter an amount between merchant-specified values greater than zero
  • Selection
    • The customer must select different merchant-specified values that include descriptive text
  • Range and Selection
    • The customer must select different merchant-specified values or can enter an amount between merchant-specified values

The sections below detail the attributes merchants can use to customize amounts.

 

Creating Editable Amounts

To provide an Amount field in which a user can enter his or her own amount, you must specify the "edit" attribute when passing the total_amount parameter (i.e., total_amount_attr="edit"). See Coding the Button for information on specifying attributes. The figure below displays an editable field:

NOTE: For ranged and selection amount configurations, Checkout ignores the "edit" attribute unless the merchant also specifies a default amount value.

 

Specifying Default Amounts

Merchants can define default amounts for their customers for ranged and selection configurations. To define a default, simply add the semi-colon and the amount to the end of the total_amount parameter (e.g., to define a ranged amount configuration that defaults to $5.00, use the following: total_amount="1-10;5"). The figure below displays a default amount within a ranged configuration:

 

Using Amount Labels

For selection configurations, merchants can define descriptive text for the different amounts (e.g., Total Outstanding Balance, Statement Balance, Minimum). To add descriptive text ,simply add it to the total_amount parameter (e.g., total_amount={1375.23, 1573.66, 56.99,0|Total Outstanding, Last Statement Balance, Minimum Balance, Specify Different Amount};500). The figure below displays Checkout with descriptive text:

 

Working with Scheduled Amounts

When scheduling transactions for customers, Checkout only supports the single or ranged Amount configurations (e.g., total_amount="50" or total_amount="1-10;5"). The merchant can also make the total_amount parameter editable so that the customer can define his or her own amount. NOTE: When scheduling, the total_amount parameter cannot contain amount selections or amount labels.

 

 

Amount Values, Defaults, and Attributes Configurations

The following sections define all the potential amount configurations available in Checkout. They also detail whether or not the Total Amount field can be rendered editable, whether the merchant can add a default value, and provide an example of Checkout for reference. See Coding the Button for sample code containing various amount configurations.

ConfigurationEdit Attribute
DefaultSample ParameterExample
Single Amounts
Single, not editableBlank/not passedPassedtotal_amount=5.30
Single, editableEditNot passedtotal_amount=""
Ranged Amounts
Ranged, not editableIgnoredNot passedtotal_amount=1.00-9.5
Ranged, not editable with defaultBlank/not passedPassedtotal_amount=1-9.5;5
Ranged, editable with default
Ranged, editable with defaultEditPassedtotal_amount=1-9.5;5
Selection Amounts
Selection, not editableIgnoredNot passedtotal_amount={20,40,60,80,100}
Selection, not editable with defaultBlank/not passedPassedtotal_amount={20,40,60,80,100,0};50
Selection, editable with defaultEditPassedtotal_amount={20,40,60,80,100,0};50
Combination Amounts
Range and Selection, not editableIgnoredNot Passedtotal_amount={20, 40, 60, 80, 100, 0}; 20-100
Range and Selection, not editable with defaultBlank/not passedPassedtotal_amount={20, 40, 60, 80, 100,0};20-1000;100
Range and Selection, editable with defaultEditPassedtotal_amount={20,40,60,80,100,0};20-1000;100

 

Mobile Support

Checkout supports transactions on both tablets and mobile phones. NOTE: Payment information (i.e., credit card or echeck account numbers ) cannot be edited on a mobile device at this time.

 

Callbacks and Webhooks

Checkout's callbacks and webhooks both contain the results of a transaction. Callbacks, however, provide real-time (synchronous), client-side notifications to the merchant while webhooks provide asynchronous server-side notifications.

 

Using Callbacks

Callbacks provide the merchant front end with synchronous updates about the current state of the checkout process, which can then be relayed to the customer through the shopping cart (via a receipt display) or other applications integrated with Checkout. The button supplied to merchants contains a callback attribute that accepts and displays notifications for the following transaction events:

  • begin - This event occurs when the customer launches the payment button. The merchant can use this event for conversion tracking data.
  • success - This event indicates that the transaction was successful.
  • failure - This event indicates that the transaction has failed. Inspect the "response_code" for more information (e.g., the merchant is over their limit processor U04). See Response Codes for more information. NOTE: If the merchant attempts an ad-hoc transaction while passing the save_token=true parameter and the transaction fails, Forte will not return the token in either the callback or the webhook.
  • error - This event indicates that the request is invalid and Checkout could not be rendered. For example, triggers for this event could include a client failing to pass a valid authentication signature, an invalid total amount, or an invalid client token.
  • abort - This event indicates that the customer canceled the checkout process by clicking on the Close button on the modal.
  • expired - This event indicates that the customer failed to complete the transaction prior to the expiration time set by the merchant via the expire_utc parameter.

 

Response Parameters

The table below details the response parameters that could be included in Checkout's callbacks.

ParameterDescriptionLengthType
signature

Used to validate callbacks coming from Forte. This parameter responds on every request. The example below displays what information this parameter will contain:

HMACMD5("api_login_id|method|version_number|total_amount|utc_time|order_number|
customer_token|paymethod_token|trace_number","Secure Transaction Key")

This parameter must be verified to confirm the validity of the returned message. An unvalidated response signature could present an exploitable weakness in your code.

variesstring
subtotal_amountThe base amount used for calculating the service_fee_amount. This field is only used for convenience fee merchants. string
service_fee_amountThe calculated percentage of a service fee. For example, a service fee of 2.45% on a $50 purchase would yield a service_fee_amount=1.23. This field only applies to convenience fee merchants. string
total_amountThe total amount of the transaction including the subtotal_amount and the service_fee_amountfor convenience fee merchants.string
version_number

The version of Checkout sending the POST message. Supported values include the following:

  • 1.0
4string
method

Supported values for this parameter include the following:

  • sale
  • schedule
  • token
  • auth
8string
event

For callbacks, supported values for this parameter include the following:

  • begin
  • success
  • failure
  • error
  • abort
  • expired

NOTE: See the Using Callbacks section for descriptions of these event types.

7string
trace_numberTrace ID number that Checkout returns after a single or scheduled transaction.36string
(guid)
order_numberA string that represents the order number associated with a
transaction.
string
utc_timeA date-time value that marks the day and time the response was sent in ticks
authorization_codeA code that references the authorization of the transaction80string
paymethod_tokenIf created, a string ID that references stored payment method(s), such as
a credit card or electronic check.
36string
customer_tokenIf created, a string ID that references stored customer information. 36string
response_codeA code that represents the transaction result. For more information on these
responses, see Response Codes.
3string
response_descriptionA text description of the transaction result80string
request_idThe request ID Checkout generated for this call36string
(guid)
hash_methodThe hash method used for the response (this parameter defaults to md5
if the request does not define it)
string
method_used

Supported types include the following:

  • visa
  • mast
  • amex
  • dine
  • jcb
  • disc
  • echeck
6string
last_4The last four numbers of a card or account number4string
expire_month

The expiration month of the card.

2string
expire_yearThe expiration year of the card.4string
xdata_#Up to nine fields (1–9) of extra data that provide more detailed descriptions of a transaction or a schedule. Each field can contain up to 80 characters.80string

 

Understanding Callback Parameters

The following table provides the callback parameters for events that occur in simple sales and scheduled transactions. The successful processing of a transaction triggers success event callbacks, which contain the result of the transaction (i.e., approved transactions). When an error event triggers a callback, the Checkout window displays the error message. Since some parameters are unavailable for some responses, those parameters may not be present in the response object.

NOTE: The "Returned Parameters" column contains example hash data.

EventReturned Parameters
Sale Method
begin
{
   "event":"begin",
   "method":"sale",
   "request_id":"1414edf7-2816-4968-ced2-b7d3e7156da7"
}
success
{
   "event":"success",
   "method":"sale",
   "request_id":"9ea365d6-40d8-416f-ca3c-1aef43529213",
   "response_code":"A01",
   "version_number":"1.0",
   "trace_number":"fb25a0c5-c5a5-4505-9c56-4297799aeb77",
   "authorization_code": "123456",
   "subtotal_amount":"50.00",
   "service_fee_amount":"1.23",
   "total_amount":"51.23",
   "expire_month":"12",
   "expire_year":"2020",
   "signature":"c1d704c4711595f48e1552a9af9b8ada",
   "utc_time": "635210889954381263",
   "hash_method":"md5"
}
failure
{
   "event":"failure",
   "method":"sale",
   "request_id":"21e2d11d-bfd9-4991-ca50-16170bc21329",
   "response_code":"U02",
   "response_description": "ACCOUNT NOT APPROVED",
   "version_number":"1.0",
   "trace_number": "89748473-6eb2-483f-81af-1d787a903f5c",
   "subtotal_amount":"50.00",
   "service_fee_amount":"1.23",
   "total_amount":"51.23",
   "last_4":"2222",
   "method_used":"echeck",
   "signature":"e83dee1c9fa2067786fb53c149ebbe62",
   "utc_time":"635295420748992999",
   "hash_method":"md5"
}
error
{
   "event":"error",
   "msg": "Invalid total_amount: 1-9.5;5d"
}
abort

{
   "event":"abort",
   "request_id":"46f27f88-5f00-4d0a-e1a3-d32b4f57bc12"
}

expired

{
   "event":"expired",
   "request_id":"9ea365d6-2816-4968-e1a3-d32b4f57bc12"
   "expire_utc":"635295420748992999"
}

Schedule Method
begin
{
   "event":"begin",
   "method":"schedule",
   "request_id":"1414edf7-2816-4968-ced2-b7d3e7156da7"
}
success
{
   "event":"success",
   "method":"schedule",
   "request_id":"5861c6fc-77ec-4ccd-ddf1-4aaf0eb309b2",
   "version_number":"1.0",
   "trace_number": "2648daca-bf23-4a1b-a789-44aa011e0ac6",
   "customer_token":"10047617",
   "paymethod_token":"14554238",
   "subtotal_amount":"50.00",
   "service_fee_amount":"1.23",
   "total_amount":"51.23",
   "expire_month":"12",
   "expire_year":"2020",
   "signature":"31aa8d43c7f65092fcba9a0506b48dfd",
   "utc_time":"635210891035249339",
   "hash_method":"md5"
}
failure
{
   "event":"failure",
   "method":"schedule",
   "request_id":"21e2d11d-bfd9-4991-ca50-16170bc21329",
   "response_code":"U02",
   "response_description":"ACCOUNT NOT APPROVED",
   "version_number":"1.0",
   "trace_number": "89748473-6eb2-483f-81af-1d787a903f5c",
   "subtotal_amount":"50.00",
   "service_fee_amount":"1.23",
   "total_amount":"51.23",
   "last_4": "2222",
   "method_used":"echeck",
   "signature": "e83dee1c9fa2067786fb53c149ebbe62",
   "utc_time":"635295420748992999",
   "hash_method":"md5"
}
error
{
   "event":"error",
   "msg":"Invalid total_amount: 1-9.5;5d"
}
abort

{
   "event":"abort",
   "request_id":"46f27f88-5f00-4d0a-e1a3-d32b4f57bc12"
}

expired

{
   "event":"expired",
   "request_id":"c29c1b64-bfd9-4968-ca50-d32b4f57bc12"
   "expire_utc":"635295420748992999"
}

Token Method
begin
{
   "event":"begin",
   "method":"token",
   "request_id":"1414edf7-2816-4968-ced2-b7d3e7156da7"
}
success
{
   "event":"success",
   "customer_token":"1035622",
   "paymethod_token": "1077158",
   "method":"token",
   "request_id":"c29c1b64-ccbf-4124-f483-3abe3776aac6",
   "version_number":"1.0",
   "last_4":"1111",
   "method_used": "visa",
   "expire_month":"12",
   "expire_year":"2020",
   "signature": "b5f4fd7b942a2635bff01a3d6aff7c03",
   "utc_time":"635295449732597770",
   "hash_method":"md5"
}
failure
{
   "event":"failure",
   "method":"token",
   "request_id":"21e2d11d-bfd9-4991-ca50-16170bc21329",
   "response_code":"U02",
   "response_description": "ACCOUNT NOT APPROVED",
   "version_number":"1.0",
   "trace_number": "89748473-6eb2-483f-81af-1d787a903f5c",
   "total_amount":"5.00",
   "last_4":"2222",
   "method_used":"echeck",
   "signature": "e83dee1c9fa2067786fb53c149ebbe62",
   "utc_time":"635295420748992999",
   "hash_method":"md5"
}
error
{
   "event":"error",
   "msg":"Invalid total_amount: 1-9.5;5d"
}
abort

{
   "event":"abort",
   "request_id":"46f27f88-5f00-4d0a-e1a3-d32b4f57bc12"
}

 

Capturing Callback Messages

Callback messages enable the merchant to present the customer with real-time status information on the transaction. To do this, merchants must capture the message by coding the callback attribute into their button:

<!DOCTYPE html>
<script type="text/javascript" src="https://sandbox.forte.net/checkout/v1/js"></script>
<button api_login_id="apiloginid"
	method="sale"
	version_number="1.0"
	utc_time="UTCtime"
	order number="ASX458956"
	callback="oncallback"
	signature="md5signature">
   Pay Now</button>

 

This button code defines that the merchant page will use the oncallback Javascript function to capture the callback message. To display the message to the customer after a transaction, the merchant must add JavaScript to parse e.data to an HTML place holder:

<head> 
   <script src="Scripts/jquery-1.11.0.min.js"></script>
   <script type="text/javascript" src="https://sandbox.forte.net/checkout/v1/js"></script>
   <script>
     function oncallback(e) {
       $('#message').html(e.data);
     }
   </script>
</head>


The e.data response object is a string that can be converted to a JSON object with a format that the merchant defines with Checkout's response parameters (see Response Parameters for more information). The sample code below shows how a merchant could use this response object to capture a callback message for customers:

<script>
   function oncallback(e) {
     var response = JSON.parse(e.data);
     switch (response.event)
     {
	case 'begin':
	  //call to forte checkout is successful
	  break;
	case 'success':
	  //transaction successful 
	  //(optional) validate from response.signature that this message is coming from forte
	  //display a receipt
	  alert('thanks for your order. the trace number is ' + response.trace_number);
	  break;
       case 'failure':
	  //handle failed transaction            
	  alert('sorry, transaction failed. failed reason is ' + response.response_description);
	}
     }
	 </script>

 

Using Webhooks

NOTE: Currently, Forte IT must configure webhooks.

Webhooks send asynchronous messages about a transaction directly to a server-side URL endpoint that a merchant defines. A webhook fires after all completed transaction requests. Forte notifies merchants about events through subscriptions. Depending on these subscriptions, multiple events can occur during an operation. For example, a credit card sale transaction that creates tokens for a customer and a paymethod causes three events to be fired: transaction.sale, customer.create, and paymethod.create. These three events can be combined under a common event ID (e.g., evt_xxxxxx) for easier information management. NOTE: Depending on how you configure your event subscriptions, the same data may be generated twice in separate webhooks. For example, creating a customer and including a paymethod could (if subscribed) generate a customer webhook with both customer and paymethod data as well as a paymethod webhook. Merchants can subscribe to the following events in version 2 and version 3 webhooks:

  • transaction.sale
  • transaction.authorize
  • customer.create
  • customer.update
  • paymethod.create
  • paymethod.update

 

The following events are only supported in version 3 webhooks:

  • schedule.create
  • schedule.update

 

NOTE: Transaction voids, credits, and updates to individual scheduleitems must be completed using the appropriate version of Forte's REST API.

If a webhook post fails (i.e., does not result in an HTTP 200 response), Forte retries the webhook post up to twenty times adding one minute for each retry.

For more information on Webhooks, see Using Webhooks.

 

Checkout supports the following types of credit card swipers for ad hoc and scheduled payments:

  • IPAD #30050202
  • Dynamag #21073062 v. 1

If the swipe parameter is set to true (see Coding the Button), Forte provides the user a button to not swipe if the merchant does not have available hardware.

The following table details potential errors you could encounter in Checkout.

Error Message
"Routing number is invalid."
"The parameter version_number is required."
"Email address is invalid."
"State is not valid."
"Invalid authentication."
"No allowed_method is available."
"Invalid parameter api_login_id."
"The browser you are using is not supported. Please download the latest version of your browser to use Checkout."
"The parameter api_login_id is required."
"The browser you are using is not supported. Checkout supports the latest versions of the following browsers: Internet Explorer, Firefox, Chrome, and Safari."
"Please either disable compatibility view or upgrade your browser to proceed."
"Scheduled transactions are not allowed for service fee merchants."
"Invalid parameter schedule_quantity: "______."
"Invalid parameter schedule_continuous: "______", Use true/false."
"Invalid schedule_quantity for continuously scheduled transaction."
"Invalid parameter schedule_frequency: "______". Use weekly, bi-weekly, monthly, bi-monthly, quarterly, semi-annually, annually. Use 0 for single future transaction."
"Invalid schedule_quantity for one-time future scheduled transaction."
"Invalid schedule_continuous for one-time future scheduled transaction."
"The parameter schedule_start_date must be a future date."
"Invalid parameter schedule_start_date: "______."
"The total_amount passed cannot be used with a method of schedule."
"Invalid parameter total_amount for scheduled transaction: "______."
"The parameter utc_time is required."
"Scheduled transactions require either setting save_token=true or passing in customer/payment token."
"Invalid parameter save_token: "______." Use true/false."
"Invalid parameter swipe: "______." Use true false."
"Invalid parameter allowed_methods: "______." Use visa/mast/disc/amex/echeck."
"Invalid total_amount for scheduled transaction."
"No payment method is available for the scheduled transaction."
"No payment method is available."
"This paymethod_token is not allowed."
"Invalid parameter hash_method: "______." Use md5/sha1/sha256."
"Invalid parameter method: "______." Use sale/schedule/token."
"Invalid parameter request_id: "______."
"The paymethod_token "______" does not exist."

"The customer_token "______" does not exist."

"The paymethod_token "______" is invalid: it does not belong to the customer."