getSessionByOrderId

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

Payments.getSessionByOrderId(id)

const value = await Payments.getSessionByOrderId(1764)

Schema

id:* number
Identifier of the retrieved payment session object
example: 1764

This method...

Example return:

{
  "id": 1764,
  "createdDate": "2025-03-02T21:56:53.600Z",
  "updatedDate": "2025-03-02T21:56:53.600Z",
  "type": "session",
  "status": "completed",
  "orderId": 1,
  "paymentAccountId": 1,
  "paymentUrl": "https://checkout.stripe.com/c/pay/cs_...",
  "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tq..."
}

Schema

id: number
object identifier
example: 1764

createdDate: string($date-time)
Object creation date

updatedDate: string($date-time)
Object modification date

type:* string
Session type Enum: [ session, intent ]
example: session

status:* string
Payment status Enum: [ waiting, completed, canceled, expired ]
example: completed

orderId:* number
Order ID
example: 1

paymentAccountId:* number
Payment account ID
example: 1

paymentUrl:* string
Payment link
example: https://checkout.stripe.com/c/pay/cs_...

clientSecret: string
Secret key
example: pi_3MtwBwLkdIwHu7ix28a3tqPa_secret...