Lewati ke konten utama

getSessionByOrderId

Dapatkan satu objek sesi pembayaran berdasarkan pengenal pesanan. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

Metode ini mengambil sesi pembayaran yang terkait dengan pesanan tertentu berdasarkan pengenal pesanan tersebut. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek ISessionEntity atau array dari objek ISessionEntity.

Pembayaran.getSessionByOrderId(

id*

);

Skema parameter

Skema

id(diperlukan): number
Pengenal pesanan
contoh: 12345

Contoh

Contoh minimal

const response = await Payments.getSessionByOrderId(1764);

Contoh respons

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

Skema respons

Skema: IAccountsEntity

id: number
Pengenal objek.
contoh: 12345

localizeInfos: ILocalizeInfo
Deskripsi Json dari objek akun pembayaran.

identifier: string
Pengenal teks untuk bidang pencatatan.
contoh: "payment_12345"

type: 'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom'
Jenis penyedia pembayaran.
contoh: 'stripe'

isVisible: boolean
Indikator visibilitas akun pembayaran.
contoh: true

isUsed: boolean
Indikator penggunaan akun pembayaran.
contoh: false

testMode: boolean
Menunjukkan apakah akun pembayaran dalam mode uji.
contoh: true

settings: IPaymentAccountSettings
Pengaturan akun pembayaran.
contoh:

{ "status": "connected" }

settings.status: string
Status koneksi akun pembayaran langsung (non-uji).
contoh: "connected"

testSettings: object
Pengaturan mode uji untuk akun pembayaran.

updatedDate: string
Tanggal modifikasi objek.
contoh: "2025-02-26T10:13:16.839Z"


Contoh penggunaan

Panduan langkah demi langkah dalam dokumentasi:

  • Pembayaran pesanan — ambil sesi pembayaran untuk pesanan yang dilakukan oleh pengguna terdaftar.
  • Pesanan tiket — dapatkan sesi pembayaran yang dibuat untuk pesanan tiket.
  • Pesanan tamu — ambil sesi pembayaran untuk pesanan tamu.

Coba secara langsung

Jalankan metode ini secara interaktif di JS SDK sandbox — sambungkan URL Proyek dan Token Aplikasi Anda pada kunjungan pertama, lalu buka:

  • Pembayaran pesanan — ambil sesi pembayaran untuk pesanan yang dilakukan oleh pengguna terdaftar.
  • Pesanan tiket — dapatkan sesi pembayaran yang dibuat untuk pesanan tiket.
  • Pesanan tamu — ambil sesi pembayaran untuk pesanan tamu.