ทำเครื่องหมาย Charge ว่าล้มเหลว

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

ทำเครื่องหมาย Charge ทดสอบว่าล้มเหลว endpoint นี้ใช้เป็นหลักสำหรับวัตถุประสงค์ในการทดสอบและการกระทบยอด โดยมีการรองรับที่จำกัดสำหรับวิธีการชำระเงินบางประเภท

---

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

▼

---

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

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

▼

`id`STRING(required)

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

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องเริ่มต้นด้วย chrg_test_, Charge ต้องอยู่ในสถานะที่มีสิทธิ์, การรองรับที่จำกัดต่อวิธีการชำระเงิน

---

การตอบกลับ

200

ทำเครื่องหมายว่าล้มเหลวสำเร็จ

สถานะของ Charge ถูกอัปเดตเป็นล้มเหลวแล้ว

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

• status - เปลี่ยนเป็น failed
• failure_code - ตั้งค่าเป็นรหัสความล้มเหลวที่เหมาะสม
• failure_message - ข้อความความล้มเหลวที่อธิบายรายละเอียด

400

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

การตรวจสอบคำขอล้มเหลว

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

• รูปแบบ Charge ID ไม่ถูกต้อง
• Charge ไม่มีสิทธิ์สำหรับการทำให้ล้มเหลวด้วยตนเอง
• ใช้ Charge จริง (รองรับเฉพาะ Charge ทดสอบเท่านั้น)

401

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

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

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

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

404

ไม่พบ

Charge ID ไม่มีอยู่

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

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

---

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

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

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

Code	คำอธิบาย	วิธีแก้ไข
not_found	Charge ID ไม่มีอยู่	ตรวจสอบว่า Charge ID ถูกต้อง
not_eligible	ไม่สามารถทำเครื่องหมาย Charge ว่าล้มเหลวได้	ตรวจสอบสถานะ Charge และวิธีการชำระเงิน
already_failed	Charge ล้มเหลวอยู่แล้ว	ไม่จำเป็นต้องดำเนินการใดๆ
not_test_charge	รองรับเฉพาะ Charge ทดสอบเท่านั้น	ใช้ key ทดสอบและ Charge ทดสอบ

---

ลองใช้งาน

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

▼

id(จำเป็น)