ดึงข้อมูล Refund ของ Charge

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

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

---

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

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

▼

`id`STRING(required)

Charge ID ที่ refund อยู่ ต้องเป็น charge ID ที่ถูกต้องจากบัญชีของคุณ

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

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

`refund_id`STRING(required)

Refund ID ที่ต้องการดึงข้อมูล ต้องเป็น refund ID ที่ถูกต้องที่เกี่ยวข้องกับ charge ที่ระบุ

Example:"rfnd_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องขึ้นต้นด้วย rfnd_, Test refunds: rfnd_test_, Live refunds: rfnd_live_

---

การตอบกลับ

200

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

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

เนื้อหาการตอบกลับ:

• id - Refund ID
• status - pending, closed หรือ failed
• amount - จำนวนเงิน refund ในหน่วยสกุลเงินที่เล็กที่สุด
• currency - รหัสสกุลเงิน
• charge - Charge ID ที่เกี่ยวข้อง
• transaction - Transaction ID ที่เกี่ยวข้อง
• created_at - Timestamp การสร้าง refund
• metadata - Metadata ที่กำหนดเอง (ถ้าตั้งค่าไว้)

400

คำขอไม่ถูกต้อง

พารามิเตอร์ที่ให้มาไม่ถูกต้อง

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

• รูปแบบ charge ID ไม่ถูกต้อง
• รูปแบบ refund ID ไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

Charge ID หรือ refund ID ไม่มีอยู่

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

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

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
refund = charge.refunds.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
refund = charge.refunds.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const refund = await omise.charges.retrieveRefund(
  'chrg_test_5xuy4w91xqz7d1w9u0t',
  'rfnd_test_5xuy4w91xqz7d1w9u0t'
);

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$refund = $charge->refunds()->retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t');

Java

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

Refund refund = client.charges()
    .get("chrg_test_5xuy4w91xqz7d1w9u0t")
    .refunds()
    .get("rfnd_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refund = await client.Charges.GetRefund(
    "chrg_test_5xuy4w91xqz7d1w9u0t",
    "rfnd_test_5xuy4w91xqz7d1w9u0t"
);

Go

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

refund, _ := client.RetrieveChargeRefund(
    "chrg_test_5xuy4w91xqz7d1w9u0t",
    "rfnd_test_5xuy4w91xqz7d1w9u0t",
    nil,
)

---

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

ค่าสถานะ Refund

สถานะ	คำอธิบาย	ขั้นตอนถัดไป
pending	กำลังประมวลผล refund	รอให้เสร็จสมบูรณ์
closed	Refund เสร็จสมบูรณ์	เงินถูกคืนให้ลูกค้าแล้ว
failed	Refund ล้มเหลว	ตรวจสอบเหตุผลความล้มเหลว

ฟิลด์ออบเจ็กต์ Refund

ฟิลด์	ประเภท	คำอธิบาย
id	string	ตัวระบุ refund ที่ไม่ซ้ำ
object	string	เป็น "refund" เสมอ
livemode	boolean	เป็น refund โหมด live หรือไม่
location	string	เส้นทาง API ไปยัง refund นี้
amount	integer	จำนวนเงิน refund ในหน่วยสกุลเงินที่เล็กที่สุด
currency	string	รหัสสกุลเงิน ISO สามตัวอักษร
charge	string	ID ของ charge ที่ถูก refund
transaction	string	ID ของ transaction ที่เกี่ยวข้อง
status	string	สถานะ refund ปัจจุบัน
created_at	string	Timestamp ISO 8601 ของการสร้าง
metadata	object	คู่ key-value ที่กำหนดเอง

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

refund_id(จำเป็น)

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