API INQUIRY STATUS

Permintaan

API Inquiry Status Transaksi memungkinkan pedagang untuk mengambil informasi status transaksi waktu nyata.

Jalur Permintaan:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-status
production: https://gateway.smilepayz.com/v2.0/inquiry-status

Parameter Header

Field	Required	Type	Description
Content-Type	M	String	Spesifikasi tipe konten HTTP Nilai tetap: application/json Diperlukan untuk parsing permintaan yang tepat
X-TIMESTAMP	M	String	Format datetime ISO 8601 dengan offset timezone Format: yyyy-MM-ddTHH:mm:ss±HH:mm Contoh: 2020-12-17T10:55:00+07:00 Catatan: Harus waktu server saat ini dalam ±5 menit
X-SIGNATURE	M	String	Tanda tangan digital untuk autentikasi permintaan. Lihat Pembuatan Tanda Tangan
X-PARTNER-ID	M	String	Pengidentifikasi pedagang unik yang ditugaskan oleh platform Format: String alfanumerik Digunakan untuk autentikasi pedagang dan routing transaksi Silakan masukkan merchantID

Parameter Body

Field	Required	Type	Description
tradeType	M	Number	Spesifikasi tipe transaksi Format: Nilai integer Nilai: 1 (Payin), 2 (Payout) Digunakan untuk mengidentifikasi kategori transaksi untuk inquiry status
orderNo	C	String(32)	Pengidentifikasi transaksi pedagang Format: String alfanumerik Panjang maksimum: 32 karakter Digunakan ketika query berdasarkan referensi transaksi pedagang
tradeNo	C	String(32)	Pengidentifikasi transaksi internal Format: String alfanumerik Panjang maksimum: 32 karakter Digunakan ketika query berdasarkan referensi transaksi sistem

Persyaratan Penting

Pengidentifikasi Transaksi Diperlukan: Setidaknya satu dari tradeNo atau orderNo harus disediakan untuk inquiry status transaksi

Contoh Body – Permintaan Inquiry Status:

POST {Base URL}/v2.0/inquiry-status HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
    "tradeType": 1,
    "orderNo": "2000112900000000000001"
}

{
    "tradeType": 2,
    "tradeNo": "112200312406111311517153"
}

Respons

Permintaan HTTP

Field	Required	Type	Description
Content-Type	M	String	Spesifikasi tipe konten respons HTTP Nilai tetap: application/json Menunjukkan format respons JSON
X-TIMESTAMP	M	String	Format datetime ISO 8601 dengan offset timezone Format: yyyy-MM-ddTHH:mm:ss±HH:mm Contoh: 2020-12-17T10:55:00+07:00

Respons Body

Field	Required	Type	Description
code	M	String	Kode status respons API yang menunjukkan hasil operasi Format: String dua digit Sukses: "00", Error: Kode lainnya Digunakan untuk penanganan respons programatik
message	M	String	Deskripsi status respons yang dapat dibaca manusia Format: String yang dikodekan UTF-8 Memberikan informasi terperinci tentang hasil operasi
tradeNo	O	String	Nomor referensi transaksi internal untuk pelacakan sistem Format: String alfanumerik yang dibuat sistem Digunakan untuk manajemen transaksi internal dan dukungan
tradeType	O	Number	Pengidentifikasi tipe transaksi untuk referensi Format: Nilai integer Nilai: 1 (Payin), 2 (Payout) Menunjukkan kategori transaksi yang diquery
paymentMethod	O	String	Metode pembayaran yang digunakan untuk transaksi Format: Kode metode pembayaran yang telah ditentukan Contoh: BCA, QRIS, DANA, BRI Menunjukkan saluran pembayaran aktual yang digunakan Lihat PaymentMethod
money	O	Object	Detail jumlah transaksi dengan spesifikasi mata uang Berisi jumlah transaksi yang dikonfirmasi dan mata uang Mungkin termasuk biaya atau penyesuaian Lihat Model Uang
currency	M	String	Spesifikasi kode mata uang ISO 4217 Nilai tetap: IDR (Rupiah Indonesia) Menentukan aturan pemrosesan pembayaran dan mata uang penyelesaian
amount	M	Number	Jumlah transaksi dalam unit mata uang terkecil Format: Nilai integer Contoh: 20000 mewakili IDR 20000 Rentang: 10000-999999999
status	O	String	Status pemrosesan transaksi saat ini Format: Kode status yang telah ditentukan Contoh: PROCESSING, SUCCESS, FAILED Menunjukkan status saat ini dari transaksi Lihat Status Transaksi
remark	O	String	Informasi transaksi tambahan dan catatan Format: String yang dikodekan UTF-8 Berisi detail tambahan tentang transaksi ketika tersedia

Contoh Body – Respons Inquiry Status:

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
    "code": "00",
    "message": "Successful",
    "money": {
        "amount": 20000,
        "currency": "IDR"
    },
    "paymentMethod": "BCA",
    "status": "SUCCESS",
    "tradeNo": "122200312406111311517153",
    "tradeType": 2
}