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

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

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

---

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

▼

---

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

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

▼

`id`STRING(required)

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

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

แนะนำ - 1 รายการพารามิเตอร์ที่แนะนำ

▼

เพิ่มเติม - 2 รายการพารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

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

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

สถานะการคืนเงินที่เป็นไปได้:

• pending - การคืนเงินกำลังดำเนินการ โดยทั่วไปลูกค้าจะเห็นเงินใน 5-10 วันทำการ
• successful - การคืนเงินเสร็จสมบูรณ์สำเร็จ
• failed - การคืนเงินล้มเหลว (หายาก)

400

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

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

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

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

401

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

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

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

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

404

ไม่พบ

ไม่พบ charge

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

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

422

ไม่สามารถประมวลผลเอนทิตี

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

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

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

---

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

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 key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	charge ID ไม่มีอยู่	ตรวจสอบว่า charge ID ถูกต้อง
charge_not_refundable	ไม่สามารถคืนเงิน charge ได้	ตรวจสอบว่าสถานะ charge สำเร็จ
insufficient_refundable_amount	จำนวนเงินเกินยอดคงเหลือที่มี	ตรวจสอบ charge.amount - charge.refunded_amount
too_many_refunds	สร้างการคืนเงิน 15 ครั้งแล้ว	การคืนเงินบางส่วนสูงสุด 15 ครั้งต่อ charge
refund_period_expired	charge เก่ากว่าช่วงเวลาการคืนเงิน	charge ต้องไม่เกิน 365 วัน

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

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

---

ลองใช้งาน

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

▼

id(จำเป็น)

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

▼

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

▼