PARAMETER

TYPE

DETAILS

qr (new)

Boolean

indicator to generate a Base64 QR image and include it in the response, default is false. (Optional)

qrsize (new)

Integer

the size of the QR image in pixels, default is 300

HEADER

TYPE

DETAILS

referenceId

String

A merchant unique reference ID for this checkout. This can be the order ID. Must match any reference shown to user during checkout / order history. (Required)

redirectUrl

String

URL to redirect user to after payment update (successful or failure)

successUrl

String

URL to redirect user to after a successful payment (optional when redirectUrl is present)

failureUrl

String

URL to redirect user to after a failed payment (optional when redirectUrl is present)

grandtotal*

Decimal

The grand total of the whole order. This is the amount customer must pay. (Required)

subtotal **

Decimal

Sum of all individual line items (without discount / tax / shipping / etc). (Required)

shipping

Decimal

Total value of shipping. (Required)

tax

Decimal

Tax value on order. (Required)

discount

Decimal

Value of discount applied to Subtotal. (Required)

currency

String

ISO 4217 Currency Code (3 letter currency code). (Required)

deviceReference (new)

String

Merchant device reference, to be used by the merchant to indicate the source device of the checkout if more than one device is used to submit checkouts to PointCheckout

items

Array

An array of objects representing the items associated with this order. (Required)

name

String

The name of the item being sold to customer. (Required)

sku

String

Merchant item SKU. (Required)

quantity

Decimal

Quantity of item being bought by user. (Required)

total

Decimal

Total selling price for quantity of this item. (Required)

customer

Object

Details of the customer making the purchase

firstName

String

Customer first name

lastName

String

Customer last name

email

String

Customer email address

phone

String

Customer phone number with international calling code (Ex. 971567xxxxxx).

billingAddress

Object

Customer billing address

name

String

Billing address name

address1

String

Billing address line 1

address2

String

Billing address line 2

city

String

Billing address city

state

String

Billing address state

zip

String

Billing zip code

country

String

Billing address country (3 letter ISO country code)

shippingAddress

Object

Customer billing address

name

String

Shipping address name

address1

String

Shipping address line 1

address2

String

Shipping address line 2

city

String

Shipping address city

state

String

Shipping address state

zip

String

Shipping zip code

country

String

Shipping address country (3 letter ISO country code)

HEADER

TYPE

DETAILS

success

Boolean

Whether or not this operation completed successfully.

elapsed

Number

Time elapsed at server processing this request.

result

Object

Result Object

checkoutId

String

Unique PointCheckout ID associated to this checkout.

checkoutKey

String

Checkout Key used for redirecting user to checkout page to complete payment. (See  PAYMENT PAGE REDIRECT)

checkoutDisplayId (new)

String

Checkout human readable short key, serves as an easier reference to the checkout

merchantId

String

The PointCheckout merchant ID associated with this checkout.

merchantName

String

The PointCheckout merchant name associated with this checkout.

referenceId

String

Merchant unique reference ID for this checkout. This should be the same as Order ID and match reference shown to user during checkout / order history.

currency

String

ISO 4217 Currency Code (3 letter currency code) associated with this checkout.

grandtotal

Decimal

The grand total of the whole order. This is the amount customer must pay.

cod (new)

Decimal

Cash amount to be collected from Shopper

status

String

Current checkout status. (See  CHECKOUT STATUSES)

deviceReference (new)

String

Merchant device reference, the same as provided in the request

firebaseDatabase (new)

String

Google firebase database name, to be used to receive notifications on checkout updates

firebaseCollection (new)

String

Google firebase collection name, to be used to receive notifications on checkout updates

firebaseDocument (new)

String

Google firebase document name, to be used to receive notifications on checkout updates

base64QR (new)

String

Base64 QR Code image data, that can be used for Quick Payment using PointCheckout Mobile App, This will only contain value when the qr Request URL query parameter is present and set to true

{

  "referenceId":"CHK-1000",

  "successRedirectUrl":"https://onlinestore.com/pointcheckout/payment-success",

  "failRedirectUrl":" https://onlinestore.com/pointcheckout/payment-success ",

  "grandtotal":"100.00",

  "subtotal":"100.00",

  "shipping":"2.0",

  "tax":"2.0",

  "discount":"4.00",

  "currency":"aed",

  "deviceReference":"POS-01",

  "items":[

    {

      "name":"Laptop XYZ case",

      "sku":"1234",

      "quantity":2,

      "total":90

    },

    {

      "name":"iPhone 7 Cover",

      "sku":"1234",

      "quantity":1,

      "total":10

    }

  ],

  "customer":{

    "firstName":"Bashar",

    "lastName":"Saleh",

    "email":"bashar.saleh@gmail.com",

    "phone":"971567824730",

    "billingAddress":{

      "name":"Bashar Saleh",

      "address1":"Business Central Towers",

      "address2":"Media city",

      "city":"Dubai",

      "state":"Dubai",

      "zip":"123",

      "country":"ARE"

    },

    "shippingAddress":{

      "name":"Bashar Saleh",

      "address1":"Business Central Towers",

      "address2":"Media city",

      "city":"Dubai",

      "state":"Dubai",

      "zip":"123",

      "country":"ARE"

    }

  }

}