สร้างการคืนเงิน

POSThttps://api.omise.co/charges/:id/refunds

ออกคำสั่งคืนเงินเต็มจำนวนหรือบางส่วนสำหรับการเรียกเก็บเงินที่สำเร็จ เงินจะถูกคืนกลับไปยังวิธีการชำระเงินเดิมของลูกค้าโดยอัตโนมัติ

---

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

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

▼

`id`STRING(required)

รหัส Charge ที่ต้องการคืนเงิน (พารามิเตอร์ใน path) การเรียกเก็บเงินต้องสำเร็จ ถูกบันทึก และสามารถคืนเงินได้

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

แนะนำ - 1 ฟิลด์พารามิเตอร์ที่แนะนำ

▼

เพิ่มเติม - 2 ฟิลด์พารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

คืนเงินสำเร็จ

สร้างการคืนเงินสำเร็จ ตรวจสอบฟิลด์ status เพื่อดูสถานะการดำเนินการ

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

• object - ค่า "refund"
• id - ตัวระบุการคืนเงิน (rfnd_*)
• livemode - โหมด live หรือ test
• location - เส้นทาง API ไปยังออบเจกต์การคืนเงิน
• acquirer_reference_number - หมายเลขอ้างอิงที่ส่งไปยังเครือข่ายบัตร
• amount - จำนวนเงินที่คืนในหน่วยสกุลเงินที่เล็กที่สุด
• approval_code - หมายเลขอ้างอิงสำหรับธุรกรรมที่อนุมัติ
• capture - การอ้างอิงการบันทึก
• charge - รหัส charge ที่เกี่ยวข้อง (ขยายได้)
• currency - รหัสสกุลเงิน ISO 4217 สามตัวอักษร
• funding_amount - จำนวนเงินในสกุลเงินที่ชำระ
• funding_currency - รหัสสกุลเงินที่ชำระ
• merchant_name - ชื่อร้านค้าย่อย (Payfac เท่านั้น)
• merchant_uid - รหัสร้านค้าย่อย (Payfac เท่านั้น)
• metadata - ข้อมูลเมตาที่กำหนดเองที่แนบกับการคืนเงิน
• status - สถานะการคืนเงินปัจจุบัน (pending, successful, failed)
• terminal - สถานที่จุดขายเดิม
• transaction - รหัสธุรกรรมที่เกี่ยวข้อง (ขยายได้)
• voided - การคืนเงินถูกดำเนินการเป็นการยกเลิกหรือไม่
• created_at - เวลาที่สร้างการคืนเงิน (ISO 8601)

400

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

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความแสดงข้อผิดพลาดสำหรับรายละเอียด

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

• รูปแบบรหัส charge ไม่ถูกต้อง
• จำนวนเงินเกินยอดที่สามารถคืนได้
• รูปแบบ metadata ไม่ถูกต้อง
• จำนวนเงินต่ำกว่าขั้นต่ำ (1 หน่วย)

401

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

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

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

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

404

ไม่พบ

ไม่พบ Charge

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

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

422

ไม่สามารถประมวลผลได้

ไม่สามารถคืนเงิน Charge ได้

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

• Charge ยังไม่สำเร็จ (ยังอยู่ระหว่างดำเนินการหรือล้มเหลว)
• Charge ถูกคืนเงินเต็มจำนวนแล้ว
• จำนวนเงินคืนเกินยอดที่สามารถคืนได้
• Charge มีการคืนเงินบางส่วนแล้ว 15 ครั้งหรือมากกว่า (ถึงขีดจำกัดสูงสุด)
• Charge เก่ากว่า 365 วัน (หรือสั้นกว่าสำหรับวิธีการชำระเงินบางประเภท)

5xx

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

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

วิธีการจัดการ:

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

---

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

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t/refunds \
  -X POST \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "amount=50000"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = Omise::Charge.refund('chrg_test_5xuy4w91xqz7d1w9u0t', {
  amount: 50000
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

refund = omise.Charge.refund('chrg_test_5xuy4w91xqz7d1w9u0t',
    amount=50000
)

Node.js

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

const refund = await omise.charges.refund('chrg_test_5xuy4w91xqz7d1w9u0t', {
  amount: 50000
});

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$refund = $charge->refund([
    'amount' => 50000
]);

Java

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

Refund refund = client.charges().refund("chrg_test_5xuy4w91xqz7d1w9u0t")
    .amount(50000L)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refund = await client.Charges.Refund("chrg_test_5xuy4w91xqz7d1w9u0t", new CreateRefundRequest
{
    Amount = 50000
});

Go

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

refund, _ := client.CreateRefund(&operations.CreateRefund{
    ChargeID: "chrg_test_5xuy4w91xqz7d1w9u0t",
    Amount:   50000,
})

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบว่าระบุฟิลด์ที่จำเป็นทั้งหมดแล้ว
authentication_failure	คีย์ API ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่มีรหัส Charge	ตรวจสอบว่ารหัส charge ถูกต้อง
charge_not_refundable	ไม่สามารถคืนเงิน Charge ได้	ตรวจสอบว่าสถานะ charge เป็น successful
insufficient_refundable_amount	จำนวนเงินเกินยอดที่สามารถคืนได้	ตรวจสอบ charge.amount - charge.refunded_amount
too_many_refunds	สร้างการคืนเงินแล้ว 15 ครั้ง	สูงสุด 15 การคืนเงินบางส่วนต่อ charge
refund_period_expired	Charge เก่ากว่าช่วงเวลาคืนเงิน	Charge ต้องมีอายุไม่เกิน 365 วัน

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

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

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

แนะนำ - 1 ฟิลด์

▼

เพิ่มเติม - 2 ฟิลด์

▼

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