ดึงข้อมูลการคืนเงิน

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

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

---

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

▼

---

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

จำเป็น - 2 รายการพารามิเตอร์ที่จำเป็น

▼

`charge_id`STRING(required)

Charge ID ที่ถูกคืนเงิน (พารามิเตอร์เส้นทาง)

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

`refund_id`STRING(required)

Refund ID ที่ต้องการดึงข้อมูล (พารามิเตอร์เส้นทาง) รูปแบบ: rfnd_test_ หรือ rfnd_live_ ตามด้วยสตริงตัวอักษรและตัวเลข

Example:"rfnd_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

ส่งกลับอบเจ็กต์การคืนเงินพร้อมรายละเอียดทั้งหมด รวมถึงสถานะ จำนวนเงิน และเวลาประทับ

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

• id - Refund ID
• status - สถานะการคืนเงินปัจจุบัน (pending, successful, failed)
• amount - จำนวนเงินที่คืนในหน่วยสกุลเงินที่เล็กที่สุด
• currency - รหัสสกุลเงิน ISO สามตัวอักษร
• charge - Charge ID ที่เกี่ยวข้อง
• transaction - Transaction ID ของการคืนเงิน
• voided - ว่าการคืนเงินถูกประมวลผลเป็น void หรือไม่
• metadata - ข้อมูลเมตาที่กำหนดเองที่แนบกับการคืนเงิน
• created_at - เวลาประทับ ISO 8601 ของการสร้างการคืนเงิน

401

ไม่ได้รับการยืนยันตัวตน

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

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

• ขาด Authorization header
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบการคืนเงินหรือ charge

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

• Refund ID ไม่ถูกต้อง
• Charge ID ไม่ถูกต้อง
• การคืนเงินเป็นของ charge อื่น
• การคืนเงินหรือ charge เป็นของบัญชีอื่น
• พิมพ์ผิด ID หรือข้อผิดพลาดในรูปแบบ

---

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

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'

refund = Omise::Refund.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t', {
  charge: 'chrg_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = omise.Refund.retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t',
    charge='chrg_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const refund = await omise.refunds.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t', 'rfnd_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$refund = OmiseRefund::retrieve('rfnd_test_5xuy4w91xqz7d1w9u0t', [
    'charge' => 'chrg_test_5xuy4w91xqz7d1w9u0t'
]);

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refund = await client.Refunds.Get("chrg_test_5xuy4w91xqz7d1w9u0t", "rfnd_test_5xuy4w91xqz7d1w9u0t");

Go

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

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

---

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

รหัสข้อผิดพลาดทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่พบการคืนเงินหรือ charge	ตรวจสอบว่า ID ถูกต้อง
invalid_refund_id	รูปแบบ Refund ID ไม่ถูกต้อง	ใช้รูปแบบ rfnd_ ที่ถูกต้อง

รหัสสถานะการคืนเงิน

สถานะ	คำอธิบาย
pending	การคืนเงินกำลังดำเนินการ
successful	การคืนเงินเสร็จสมบูรณ์แล้ว
failed	การคืนเงินล้มเหลว (หายาก)

---

ลองใช้งาน

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

▼

charge_id(จำเป็น)

refund_id(จำเป็น)