ดึงข้อมูล Charge

GEThttps://api.omise.co/charges/:id

ดึงรายละเอียดของ charge ที่มีอยู่ คืนค่าข้อมูลทั้งหมดเกี่ยวกับ charge รวมถึงสถานะ วิธีการชำระเงิน และรายละเอียดธุรกรรม

---

พารามิเตอร์คำขอ

จำเป็น - 1 ฟิลด์พารามิเตอร์ที่จำเป็น

▼

`id`STRING(required)

Charge ID ที่ต้องการดึงข้อมูล ต้องเป็น charge ID ที่ถูกต้องจากบัญชีของคุณ

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องขึ้นต้นด้วย chrg_, Test charges: chrg_test_, Live charges: chrg_live_

---

การตอบกลับ

200

ดึงข้อมูลสำเร็จ

คืนค่า charge object ที่สมบูรณ์พร้อมฟิลด์ทั้งหมด

การตอบกลับประกอบด้วย:

• status - pending, successful, failed, expired หรือ reversed
• amount - จำนวนเงินของ charge ในหน่วยสกุลเงินที่เล็กที่สุด
• paid - การชำระเงินเสร็จสมบูรณ์หรือไม่
• authorized - charge ได้รับการอนุมัติหรือไม่
• card / source - รายละเอียดวิธีการชำระเงิน
• refunds - รายการการคืนเงิน (ถ้ามี)
• failure_code / failure_message - รายละเอียดข้อผิดพลาดถ้าล้มเหลว

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือขาดหายไป

สาเหตุทั่วไป:

• ขาด Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key

404

ไม่พบ

Charge ID ไม่มีอยู่

สาเหตุทั่วไป:

• Charge ID ไม่ถูกต้อง
• Charge จากบัญชีอื่น
• ใช้ test key สำหรับ live charge (หรือในทางกลับกัน)

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ เกิดขึ้นไม่บ่อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const charge = await omise.charges.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Charge charge = client.charges().get("chrg_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charge = await client.Charges.Get("chrg_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

charge, _ := client.RetrieveCharge("chrg_test_5xuy4w91xqz7d1w9u0t", nil)

---

รหัสข้อผิดพลาดและผลลัพธ์

ค่าสถานะ Charge

สถานะ	คำอธิบาย	ขั้นตอนถัดไป
pending	รอการดำเนินการของลูกค้า	รอ webhook หรือ poll เป็นระยะ
successful	การชำระเงินเสร็จสมบูรณ์	ดำเนินการตามคำสั่งซื้อ
failed	การชำระเงินล้มเหลว	ตรวจสอบ failure_code และ failure_message
expired	Charge หมดอายุ	สร้าง charge ใหม่
reversed	ยกเลิกการอนุมัติล่วงหน้า	ไม่มีการโอนเงิน

Boolean Flags

ฟิลด์	คำอธิบาย	กรณีการใช้งาน
paid	การชำระเงินเสร็จสมบูรณ์	ตรวจสอบก่อนดำเนินการตามคำสั่งซื้อ
authorized	เงินได้รับการอนุมัติ	สถานะการอนุมัติล่วงหน้า
capturable	สามารถจับยอดการอนุมัติล่วงหน้าได้	ตรวจสอบก่อนจับยอด
refundable	สามารถสร้างการคืนเงินได้	ตรวจสอบก่อนคืนเงิน
reversible	สามารถย้อนกลับการอนุมัติล่วงหน้าได้	ตรวจสอบก่อนย้อนกลับ

---

🔑ข้อมูลยืนยันตัวตน API

▼

ลองใช้งาน

จำเป็น - 1 ฟิลด์

▼

id(จำเป็น)

IP ของคุณ: ...กำลังโหลด...