Checkout Page

UNIPaaS checkout page allows merchants to accept digital payments on any device or channel.

By using the checkout page you reduce the effort involved in PCI compliance, which is required from merchants handling sensitive credit card information. The checkout page fully supports Strong Customer Authentication (3DSecure 2). Please follow this step-by-step guide for quick integration.

Checkout Object Properties

Parameter

Type

Description

Required

amount

Number

The Amount of the payment

Yes

currency

String

The Currency of the payment

Yes

orderId

String

Unique ID from the merchant system

Yes

email

String

The buyer's email address

Yes

country

String

The buyer's country code. ISO 2 letters

Yes

item

Array of Objects

Used to split payments between multiple vendors or a vendor and the platform.

Yes

successfulPaymentRedirect

String

A url to redirect the user after a successful checkout.
Example : https://mywebsite.com/success

No

The item object (for splitting payments)

The items Object is part of the Checkout Object and describes the order item details per vendor. In this Object you can set the platform fee per vendor.

Field

Description

name

A description of the item

amount

The amount of the specific item.

_Please note that the itemAmount field you are asked to send to UNIPaaS via this API call needs to be the final item's amount - taking in consideration both line and subtotal discounts.

For example: if a buyer uses a coupon and receives a 20GBP discount - we will ask you to send us a new post-discount amount for each item.

Numeric example:
Item 1 - 100 
item 2 - 100 
Subtotal - 200

Discount - 20
Total - 180 

You need to send:
For item 1 - 90
For item 2 - 90_

The itemAmount total value must be equal to the Amount value (the total amount) sent in the Authorization Object

vendorId

The unique Id of the vendor provided by UNIPaaS during vendor Onboarding

platformFee

The fee percentage for a specific item

Open the link from your website

You can redirect, open the link in a modal, or embed it as Iframe in the existing page.

Verify the Authorization status from your server side

Authorization verification is essential to ensure no manipulation occurred on the client-side.
Make a GET /pay-ins/{authorizationId} request:

curl --location --request GET 'https://sandbox.unipaas.com/platform/pay-ins/{authorizationId}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer --PRIVATE_KEY--'

Authorization status must be CAPTURED for a successful Authorization.
Check the Authorization statuses options for more information.

📘

Please note: If you send a transaction without any vendor ID - the transaction will be entered to the platform e-wallet and will be listed as a platform transaction

Test your integration

Use our test scenarios test your integration