ย้อนกลับ Charge

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

ย้อนกลับ Charge ที่ได้รับการอนุมัติล่วงหน้าและปลดล็อกเงินของลูกค้าโดยไม่ดำเนินการชำระเงิน ใช้ได้เฉพาะกับ charge ที่สร้างด้วย capture=false เท่านั้น

---

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

▼

---

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

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

▼

`id`STRING(required)

charge ID ที่ต้องการย้อนกลับ ต้องเป็น charge ที่ได้รับการอนุมัติล่วงหน้าและยังไม่ได้ดำเนินการชำระเงิน (status: successful, capture: false, reversible: true)

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องขึ้นต้นด้วย chrg_, ต้องได้รับการอนุมัติล่วงหน้า (capture: false), ต้องสามารถย้อนกลับได้ (reversible), ต้องอยู่ภายในช่วงระยะเวลาอนุมัติ 7 วัน

---

การตอบกลับ

200

ย้อนกลับสำเร็จ

ยกเลิกการอนุมัติล่วงหน้าแล้ว เงินจะถูกคืนให้กับลูกค้า

การเปลี่ยนแปลงฟิลด์หลักหลังจากย้อนกลับ:

• status - เปลี่ยนจาก successful เป็น reversed
• reversed - เปลี่ยนจาก false เป็น true
• reversed_at - ตั้งค่าเป็นเวลาปัจจุบัน
• reversible - เปลี่ยนจาก true เป็น false
• capturable - เปลี่ยนจาก true เป็น false

400

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

พารามิเตอร์ไม่ถูกต้องหรือไม่สามารถย้อนกลับ charge ได้

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

• Charge ได้ดำเนินการชำระเงินแล้ว (กรุณาใช้ refund แทน)
• รูปแบบ charge ID ไม่ถูกต้อง
• Charge ไม่ได้รับการอนุมัติล่วงหน้า

401

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

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

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

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

404

ไม่พบข้อมูล

ไม่มี Charge ID นี้

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

• charge ID ไม่ถูกต้อง
• charge จากบัญชีอื่น
• ใช้ test key กับ charge จริง (หรือในทางกลับกัน)

422

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

ไม่สามารถย้อนกลับ Charge ได้

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

• Charge ได้ย้อนกลับแล้ว
• Charge ได้ดำเนินการชำระเงินแล้ว (ไม่สามารถย้อนกลับ charge ที่ดำเนินการแล้ว)
• Charge ไม่สามารถย้อนกลับได้ (หมดอายุหรือสถานะไม่ถูกต้อง)
• การอนุมัติหมดอายุแล้ว (เกินระยะเวลา 7 วัน)

---

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

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t/reverse \
  -X POST \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.reverse('chrg_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.reverse('chrg_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const charge = await omise.charges.reverse('chrg_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$charge->reverse();

Java

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

Charge charge = client.charges().reverse("chrg_test_5xuy4w91xqz7d1w9u0t")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var charge = await client.Charges.Reverse("chrg_test_5xuy4w91xqz7d1w9u0t");

Go

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

charge, _ := client.ReverseCharge("chrg_test_5xuy4w91xqz7d1w9u0t", nil)

---

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

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

Code	Description	Resolution
not_found	ไม่มี Charge ID นี้	ตรวจสอบว่า Charge ID ถูกต้อง
already_reversed	Charge ได้ย้อนกลับแล้ว	ไม่จำเป็นต้องดำเนินการใดๆ
already_captured	Charge ได้ดำเนินการชำระเงินแล้ว (กรุณาใช้ refund)	ไม่สามารถย้อนกลับ charge ที่ดำเนินการแล้ว
not_reversible	ไม่สามารถย้อนกลับ Charge ได้	ตรวจสอบว่าฟิลด์ reversible เป็น true
authorization_expired	การอนุมัติล่วงหน้าหมดอายุแล้ว (เกิน 7 วัน)	ไม่สามารถย้อนกลับการอนุมัติที่หมดอายุแล้ว

ข้อกำหนดในการย้อนกลับ

Field	Required Value	Description
status	successful	ต้องได้รับการอนุมัติแล้ว
capture	false	ต้องเป็นการอนุมัติล่วงหน้า
reversible	true	ต้องสามารถย้อนกลับได้
reversed	false	ยังไม่ได้ย้อนกลับ
Age	< 7 days	ต้องอยู่ภายในระยะเวลาอนุมัติ

---

ลองใช้งาน

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

▼

id(จำเป็น)