Retrieve a checkout session

id

string

The ID of the checkout session.

apiKey

string

Partner’s x-api-key used for authenticating partner's identity.

paymentIntentId

string

The unique identifier for the payment transaction.

More information can be found in the How payment intents work page.

paymentIntentStatus

string

The current status of the payment intent.

The full list of statuses can be found in the Payment intent status page.

status

string

The status of the session.

paymentMethod

object

The payment method for this session.

paymentMethod.family

string

The family the payment method belongs to.

paymentMethod.type

string

The payment method type.

paymentMethod.brand

string

The payment method brand.

merchantId

string

The merchant ID of a particular merchant.

subMerchant

object

⚠️Required for Third-Party Acquirers
Partner's merchant information (lowest level merchant).

This will be used to display on our checkout page and e-receipt.

subMerchant.name

string

The name of partner's merchant.

subMerchant.reference

string

The partner's merchant's ID provided by partners.

referenceId

string

A unique string to reference the wallet transaction.

This can be an order ID, a cart ID, or something similar generated by the merchant’s side.

capture

boolean

An identifier to see if the transaction is a captured transaction.

More information can be found in the capture method page.

amount

string

The total amount of all items after discounts and taxes.

capturedAmount

string

The amount captured.

refundedAmount

string

The amount refunded.

currency

string

The three-letter ISO currency code of the payment.

Currently, only supports MYR which is the default value.

referenceMeta

object

An object to store additional information about the transaction (e.g., order details, etc.).

referenceMeta.items

object

Stores an array of items that is included in the transaction.

referenceMeta.items.itemName

string

Name and description of the item.

referenceMeta.items.variationName

string

Item variation.
E.g: M, Red.

referenceMeta.items.unitPrice

float

The price per item.

referenceMeta.items.quantity

integer

The number of this product purchased.

referenceMeta.items.totalPrice

float

Total price = item quantity x item unit price

referenceMeta.items.totalDiscountedPrice

float

The total price after discount.

referenceMeta.totalDiscount

float

The total amount of discount given.

referenceMeta.subtotal

float

The total amount before applying any taxes or discount, fee, etc.

referenceMeta.shippingFee

float

The shipping fee (applicable for e-commerce).

referenceMeta.pumpNumber

string

The code for the pump being operated.

referenceMeta.stationName

string

The name of the station where the operating pump is located.

locale

string

Stores the name of the location/region.

createdAt

date string

The time the checkout session was created.

updatedAt

date string

The time the checkout session was last updated.

error

string

Displays the error that is returned by the Setel server.