ดึงข้อมูล Charge

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

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

---

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

▼

---

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

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

▼

`id`STRING(required)

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

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องขึ้นต้นด้วย chrg_, Charge ทดสอบ: chrg_test_, Charge จริง: chrg_live_

---

การตอบกลับ

200

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

ส่งคืนออบเจ็กต์ charge ที่สมบูรณ์พร้อมทุกฟิลด์

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

• 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 จากบัญชีอื่น
• ใช้ key ทดสอบกับ charge จริง (หรือในทางกลับกัน)

---

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

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 หรือตรวจสอบเป็นระยะ
successful	การชำระเงินเสร็จสมบูรณ์	ดำเนินการคำสั่งซื้อ
failed	การชำระเงินล้มเหลว	ตรวจสอบ failure_code และ failure_message
expired	Charge หมดอายุ	สร้าง charge ใหม่
reversed	การอนุมัติล่วงหน้าถูกยกเลิก	ไม่มีการโอนเงิน

แฟล็ก Boolean

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

---

ลองใช้งาน

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

▼

id(จำเป็น)