Hosted Payment Page

The gateway provides a page where customer can enter payment details and securely complete a transaction.

Customization

To configure a hosted payment page appearance, please, follow the steps:

  • Log in to your Merchant portal.
  • Go to Developer settings > Website settings > Payment Page content.
  • Select the website.
  • Click on the “Edit template” button and customize the page elements.

Create HPP request

POST https://api.quaife.net/v1/transactions/

Parameters

Transaction type

Type

Description

amount
number
Transaction Amount
currency
string
ISO 3 Currency Code
action
string
Enum: “Authorize”, “Purchase”, “Autocapture” – applicable to card payments
customer
object
Link to customer object
paymentMethods
array of string
An array of all the payment methods to be shown when showing the Hosted Payment Page (Can be left out to show all)
statementDescriptor
string <= 21
An optional billing descriptor displayed on the account owner’s statement
description
string <= 150
Transaction description
reference
string <= 20
Merchant reference
ipAddress
string <= 45 characters
Consumer’s IP Address
successUrl
string <= 255 characters
For redirect payment methods, this overrides the default success redirect URL configured on your account
cancelUrl
string <= 255 characters
For redirect payment methods, this overrides the default cancel redirect URL configured on your account
failureUrl
string <= 255 characters
For redirect payment methods, this overrides the default failure redirect URL configured on your account

Customer object parameters

Parameter

Type

Required

Description

firstName
string <= 100 characters
Yes
The customer’s first name
lastName
string <= 100 characters
Yes
The customer’s last name
email
string <= 256 characters
Yes
The customer’s email address
phone
string => 8, <= 18 characters
No

The customer’s phone number

accountReference
string => 5, <= 32 characters
Required for PayTM, UPI and IMPS payment methods
The merchant defined account reference
category
string <= 50 characters
No
The merchant defined category
streetAddress
string <= 50 characters
Required for Cash, BankTransfer and CAD payment methods
The street address

city

string <= 50 characters
Required for Cash, BankTransfer and CAD payment methods
The address city
postcode

string <= 12 characters

Required for Cash, BankTransfer and CAD payment methods
The address zip/postal code
country
string
Required for Cash, BankTransfer and CAD payment methods
The two-letter ISO country code of the address
state
string <= 3 characters
Required for Cash, BankTransfer and CAD payment methods
The two/three-letter ISO state code for that country
phone
string ex:”+14034881071″
Required for CAD payment methods

should be in this format : “+14034881071”

JSON Request object

{
“amount”:10.26,
“currency”:”EUR”,
“action”:”Authorize”,
“customer”:{
“firstName”: “April”,
“lastName”: “King”,
“email”: “Dsdfsdf@example.net”,
“phone”: “+234323423”,
“accountReference”:”acc0002″,
“address”: {
“streetAddress”:”StreetAddress”,
“city”: “Boston”,
“postcode”:”01010″,
“country”:”US”
}
},
//”paymentMethods” : [“PAYMENTMETHOD”],
“statementDescriptor”:”Purchase my-shop.com”,
“Description”:”T-Shirt XXL”,
“Reference”:”ORD24234″,
“ipAddress”:”188.2.20.211″,
“successUrl”:”https://www.example.com/home/success”,
“cancelUrl”:”https://www.example.com/home”,
“failureUrl”:”https://www.example.com/home/cancel”
}

JSON Response Object

{
“id”: “hpp_huynczx2xt”,
“status”: “Requested”,
“amount”: 10.26,
“currency”: “EUR”,
“customer”: {
“id”: “cus_6owt621zga”,
“firstName”: “April”,
“lastName”: “Kling”,
“email”: “Dxxxxxxxxxxxxi@example.net”
},
“created”: “2021-01-06T15:58:46.7142738Z”,
“links”: [
{
“href”: “https://api.quaife.net/payment-page/u9qjb7m8bsuog7sm5ltho8soaj83towkdikuyrs3/info”,
“rel”: “redirect”,
“method”: “GET”
}
]
}

MERCHANT

Should you be interested in becoming a merchant, then please fill out the short form below and one of our specialists will be in touch shortly.

SIGN UP

We are delighted that you are considering using Quaife as your payment partner. Fill in the form below & let’s get started.