API Reference
API Reference

Object

Field

Type

Description

id

int64

Unique identifier for the Checkout Session

access_no

string

Access number assigned to the integrated party

merchant_id

string

Unique identifier for the merchant

order_id

string

Order ID from the integrated platform

trade_id

string

Unique identifier for the associated trade order

customer

Customer

Customer information

status

string

Checkout Session status:

  • open: Successfully created
  • expire: Expired
  • complete: Transaction completed

expire_time

int64

​​Validity period (in seconds). The expiration timestamp can be calculated by adding this value to the session's creation time.​​

return_url

string

The URL to redirect customers to after a successful payment

cancel_url

string

The URL to redirect customers to after a canceled payment

callback_url

string

Endpoint URL for receiving webhook notifications

session_url

string

URL for the hosted checkout page

mode

string

Payment mode, which determines whether to validate product data

  • checkout: Validates product data (default)
  • payment: Does not validate product data

total_amount

string

Total amount for the transaction

integration_method

string

Integration method:

  • hosted: Hosted Checkout (default)
  • embedded : Embedded Checkout

redirect_on_completion

string

Redirection behavior for Embedded Checkout:

  • always: Always redirect to return_url after successful payment
  • if_required: Redirect to return_url only for payment methods that require redirection

created_at

string

Session creation time

payment_token

string

Payment tokens returned for subscription payments. Used to process subsequent renewal charges without re-collecting customer payment details.

Customer

FieldTypeDescription
idstringUnique identifier for the customer on the Subotiz platform
payer_idstringUnique identifier for the customer in the integrated platform
emailstringCustomer's email address