SHP - Secure Hosted Pages

SHP - Secure Hosted Pages

Secure Hosted Pages

Migrating from Legacy Hosted Pages 


In an effort to simplify redirect, The new Secure Hosted Pages (SHP) is very different from the old version. The new SHP mirrors Secure Hosted Checkout (SHC) fairly closely, making it easier to transition between the two solutions.


Endpoints

New Endpoints

Test

Production


API Keys

The old API key was embedded in a variable in the body if the request. With the new SHP, a new API key will be provided by PayFacto which will reside in the HTTP header of the request.

Payloads

New Session Payload

The required field for the new payload is much simpler than the old payload. Only the following payload parameter is mandatory:

  1. transactionType
    1. the type of transaction SHP is to process

An example of this would be:

transactionType Example
transactionType Example
{ transactionType: "VERIFY" }

 Here are a list of the optional parameters:

  • amount

    • how to display the amount field.

    • Valid values are disabled, editable and hidden

  • avs

    • how to display the AVS fields.

    • Valid values are address, both, and postal

  • description

    • add a description of the link.

    • Maximum length is 60 characters

  • email

    • display the e-mail field.

    • Default is false

  • expires

    • the date and time the page will expire in ISO-8601 format (YYYY-MM-DDTHH:MM:SS)

  • invoice

    • how to display the invoice field.

    • Valid values are disabled, editable, and hidden

  • invoiceNumber

    • the invoice number of the request.

    • Maximum length is 25 characters

  • language

    • the language the page should be displayed in.

    • Valid values are en and fr. 

    • English (en) is the default value.

  • purchaseAmount

    • the amount of the purchase denominated in minor currency values (i.e $1 = 100)

  • sendEmail

    • send an email to the customer with the link.

    • The default is false

  • uses

    • The number of times a link can be used.

    • The default is 1.

  • successUrl

    • where to redirect the customer after a successful payment

  • declineUrl

    • where to redirect the customer after an unsuccessful payment


Info
The optional parameters no longer need to be base64 encoded.
They can be passed as a JSON object in the request body.

optional parameters example
optional parameters example
{
  "header": "POST",
  "headers": {
    "Authorization": "Basic {API key}",
    "Content-Type": "application/json; charset=utf-8",
    "Accept": "application/json"
  },
  "body": "{ \"transactionType\": \"PURCHASE\"}"
}

 



    • Related Articles

    • Hosted Payment Page

      Introduction This page aims to train future users of the secure redirection of the PayFacto payment solution. You will find in this page a description of the secure redirection service, the operation, the various call and return parameters, the ...

    • SHC - Secure Hosted Checkout

      Secure Hosted Checkout What is Secure Hosted Checkout? Secure Hosted Checkout (SHC) is a JavaScript library that allows merchants to collect and send cardholder information to PayFacto for authorization (pre-authorization), purchase, or verification ...

    • API v1.0 - SHC - Secure Hosted Checkout

      About SHC What is Secure Hosted Checkout? Secure Hosted Checkout (SHC) is a JavaScript library that allows merchants to collect and send cardholder information to PayFacto for verification without needing to access that information directly. When ...

    • Construct a Secure Hosted Checkout (Legacy) Log

      This article explains how to construct and put together all the sequential activities related to a Secure Hosted Checkout transaction for debugging purposes. 1. View log You can use this view log to help locating all these info easily and by ...

    • SPL - Secure Pay By Link

      Secure Pay By Link Secure Pay By Link (SPL) is a new offering from PayFacto that allows a merchant to defer a SHC session to another time. It does that by creating a link that the cardholder can follow to a hosted page. When the cardholder navigates ...