Main Entities

Authorization

Authorization is the main object to create a payment. The authorization object contains all the relevant transactions of a specific payment and the updated status of the payment.

📘
Authorizations are created automatically during the payment flow (with checkout page or web SDK).
You will create Authorization by yourself only if you use our API only integration (server-to-server).

Authorization properties

Parameter	Type	Description
`authorizationId`	String	Unique ID of the Object
`authorizationStatus`	Enum	The status of the Authorization, see below detailed information
`paymentOption`	Object	The payment Option details
`currency`	String	The Currency of the payment
`amount`	Number	The Amount of the payment
`orderId`	String	Unique ID from the merchant system
`processor`	Object	Additional data from the acquirer
`items`	Array of Objects	The items of the order, per item per vendor
`transactionId`	String	The transaction ID of the specific payment operation

The statuses of Authorization object:

Status	Meaning
`INITIALIZED`	payment was created on unipaas system, but yet sent to the acquirer.
`AUTHORIZED`	The payment details of the shopper are verified, and the funds are reserved
`CAPTURED`	The reserved funds are transferred from the shopper to your account
`VOIDED`	The payment was cancelled. The funds are transferred from your account to the shopper
`REFUNDED`	The payment was refunded. The funds are transferred from your account to the shopper
`PARTIALLY_REFUNDED`	The payment was partially refunded
`PARTIALLY_CAPTURED`	The payment was partially captured
`PARTIALLY_VOIDED`	The payment was partially cancelled
`DECLINED`	The payment was declined
`PENDING`	The payment response was not received yet (usually happens with alternative payment methods)
`PENDING_3D`	True only for transaction type card where 3DS is enabled and the 3D authentication requested from the user is yet to be completed
`CANCELLED`	The payment was cancelled by the shopper. No funds were transferred
`ERROR`	There was an error during the payment flow

The items Object

The items Object is part of the Authorization Object and describes the order item details per vendor. In this Object you can set the platform fee per item 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

Payment Option

A Payment Option resource represents either a Credit Card, bank account, or Alternative Payment Method. A Payment Option may be tokenized multiple times, and each tokenization produces a unique ID called paymentOptionId.

📘
Each paymentOptionId may only be associated one time and to only one Identity (Consumer/Vendor/Platform).

Payment Option properties

Parameter	Type	Description
`paymentOptionId`	String	The unique ID of the Object
`PaymentOptionType`	Enum	CARD_ - Credit or Debit Card BANK_ - Bank Account APM_ - Alternative Payment Method
`cardAccount`	Object	The card details block
`bankAccount`	Object	The bank details block
`IdentityType`	Enum	CONSUMER_ - End User/Buyer PLATFORM_ - Digital Platform/ Merchant VENDOR_ - Vendor/Sub-merchant

Authorization

Authorizations are created automatically during the payment flow (with checkout page or web SDK). You will create Authorization by yourself only if you use our API only integration (server-to-server).

Authorization properties

The statuses of Authorization object:

The items Object

Payment Option

Payment Option properties

Authorizations are created automatically during the payment flow (with checkout page or web SDK).
You will create Authorization by yourself only if you use our API only integration (server-to-server).