ทำให้ Charge หมดอายุ

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

ทำให้ Charge ที่รอดำเนินการและยังไม่ได้รับการอนุมัติหมดอายุด้วยตนเอง ใช้ได้เฉพาะกับวิธีการชำระเงินบางประเภทที่มีฟลการทำงานแบบเปลี่ยนเส้นทาง

---

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

▼

---

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

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

▼

`id`STRING(required)

Charge ID ที่จะทำให้หมดอายุ จะต้องเป็น Charge ที่รอดำเนินการและยังไม่ได้รับการอนุมัติ ใช้ได้เฉพาะกับ source การชำระเงินที่รองรับ (Alipay CN/HK, DANA, GCash, KakaoPay, PayPay, Touch 'n Go)

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องขึ้นต้นด้วย chrg_, สถานะของ Charge ต้องเป็น pending, ต้องสร้างผ่าน source ที่รองรับ

---

การตอบกลับ

200

หมดอายุสำเร็จ

Charge ถูกทำเครื่องหมายว่าหมดอายุแล้ว ลูกค้าไม่สามารถชำระเงินให้เสร็จสิ้นได้อีกต่อไป

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

• status - เปลี่ยนจาก pending เป็น expired
• expired - เปลี่ยนจาก false เป็น true
• expired_at - ตั้งค่าเป็นเวลาปัจจุบัน

400

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

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

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

• รูปแบบ 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 ไม่ได้อยู่ในสถานะ pending (สำเร็จ, ล้มเหลว หรือหมดอายุแล้ว)
• Charge ได้รับการอนุมัติแล้ว
• วิธีการชำระเงินไม่รองรับการทำให้หมดอายุด้วยตนเอง
• Charge สร้างด้วยบัตรแทนที่จะเป็น source ที่รองรับ

---

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

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

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

Code	คำอธิบาย	วิธีแก้ไข
not_found	Charge ID ไม่มีอยู่	ตรวจสอบว่า Charge ID ถูกต้อง
not_pending	Charge ไม่ได้อยู่ในสถานะ pending	สามารถทำให้หมดอายุได้เฉพาะ Charge ที่ pending เท่านั้น
already_expired	Charge หมดอายุแล้ว	ไม่จำเป็นต้องดำเนินการใดๆ
not_expirable	วิธีการชำระเงินไม่รองรับ	ตรวจสอบ source ที่รองรับ
already_authorized	Charge ได้รับการอนุมัติแล้ว	ไม่สามารถทำให้ Charge ที่อนุมัติแล้วหมดอายุได้

วิธีการชำระเงินที่รองรับ

วิธีการชำระเงิน	รองรับ	หมายเหตุ
Alipay CN	ใช่	สามารถทำให้ Charge ที่รอดำเนินการหมดอายุได้
Alipay HK	ใช่	สามารถทำให้ Charge ที่รอดำเนินการหมดอายุได้
DANA	ใช่	สามารถทำให้ Charge ที่รอดำเนินการหมดอายุได้
GCash	ใช่	สามารถทำให้ Charge ที่รอดำเนินการหมดอายุได้
KakaoPay	ใช่	สามารถทำให้ Charge ที่รอดำเนินการหมดอายุได้
PayPay	ใช่	สามารถทำให้ Charge ที่รอดำเนินการหมดอายุได้
Touch 'n Go	ใช่	สามารถทำให้ Charge ที่รอดำเนินการหมดอายุได้
Credit Card	ไม่	บัตรมีขั้นตอนการทำงานที่แตกต่างกัน
PromptPay	ไม่	PromptPay จะหมดอายุโดยอัตโนมัติ

---

ลองใช้งาน

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

▼

id(จำเป็น)