Skip to main content

getSessionByOrderId

Get one payment session object by order identifier. 🔐 This method requires authorization.

Description​

It returns a Promise that resolves to an object IAccountsEntity.

Payments.getSessionByOrderId(

id

);

Parameters schema​

Schema

id(required): number
Order identifier
example: 12345

Examples​

Minimal example​

const response = await Payments.getSessionByOrderId(1764);

Example response​

{
  "id": 1,
  "createdDate": "2025-02-25T10:52:59.634Z",
  "updatedDate": "2025-02-25T10:52:59.634Z",
  "type": "session",
  "status": "waiting",
  "paymentAccountId": 1,
  "orderId": 2,
  "paymentUrl": null
}

Response schema​

Schema: IAccountsEntity

id: number
Object identifier.
example: 12345

localizeInfos: ILocalizeInfo
Json description of the payment account object.

identifier: string
Text identifier for the recording field.
example: "payment_12345"

type: 'stripe' | 'custom'
Type may be 'stripe' or 'custom'.
example: 'stripe'

isVisible: boolean
Visibility indicator of the payment account.
example: true

isUsed: boolean
Usage indicator of the payment account.
example: false