Checkitout is still in early development, API are prone to change. Please report any issues you find.

Type

Type references for the Checkitout SDK

CheckitoutOptions

The options for initializing the Checkitout instance

Prop	Type	Default
`token`	`string`	-
`apiUrl`	`string`	`"https://api-checkitout.rinyato.com"`
`webUrl`	`string`	`"https://checkitout.rinyato.com"`

Checkout

Type reference for Checkout, this is all the available properties in a checkout object

Prop	Type	Default
`id`	`string`	-
`refId`	`string`	-
`currency`	`Currency`	-
`discountType`	`"AMOUNT" \| "PERCENTAGE"`	-
`discount`	`number`	-
`tax`	`number`	-
`subTotal`	`number`	-
`total`	`number`	-
`clientName`	`string`	-
`clientPhone`	`string`	-
`clientAddress`	`string`	-
`redirectUrl`	`string`	-
`additionalInfo`	`AdditionalInfo`	-
`createdAt`	`Date`	-
`updatedAt`	`Date`	-

CheckoutRequest

Type reference for CheckoutRequest, this is all the options that can be passed to checkitout.create(...)

Prop	Type	Default
`currency`	`Currency`	-
`discount`	`Discount`	`undefined`
`tax`	`number`	`undefined`
`total`	`number`	`undefined`
`client`	`ClientInfo`	-
`additionalInfo`	`AdditionalInfo`	`undefined`
`redirectUrl`	`string`	-
`items`	`CheckoutItemRequest[]`	-

CheckoutItem

Type reference for CheckoutItem, this is all the properties in a checkoutItem object

Prop	Type	Default
`id`	`string`	-
`checkoutId`	`string`	-
`productId`	`string`	-
`name`	`string`	-
`img`	`string`	-
`price`	`number`	-
`quantity`	`number`	-
`discountType`	`"AMOUNT" \| "PERCENTAGE"`	-
`discount`	`number`	-

CheckoutItemRequest

Type reference for CheckoutItemRequest, this is all the options that can be passed

Prop	Type	Default
`productId`	`string`	`undefined`
`name`	`string`	-
`img`	`string`	-
`price`	`number`	-
`quantity`	`number`	-

Transaction

Type reference for Transaction, this is all the properties in a transaction object

Prop	Type	Default
`id`	`string`	-
`checkoutId`	`string`	-
`md5`	`string`	-
`qrCode`	`string`	-
`amount`	`number`	-
`currency`	`Currency`	-
`status`	`TransactionStatus`	-
`createdAt`	`Date`	-
`updatedAt`	`Date`	-

Discount

Prop	Type	Default
`type`	`"AMOUNT" \| "PERCENTAGE"`	-
`value`	`number`	-

ClientInfo

Prop	Type	Default
`name`	`string`	-
`phone`	`string`	-
`address`	`string`	-

Currency

KHR Cambodian Riel
USD United States Dollar

TransactionStatus

TIMEOUT: The transaction has expired
PENDING: The transaction is still pending
SUCCESS: The transaction has been completed
FAILED: The transaction has failed

Previous

Reference

On this page

CheckitoutOptions Checkout CheckoutRequest CheckoutItem CheckoutItemRequest Transaction Discount ClientInfo Currency TransactionStatus