จับการชาร์จ

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

จับการชาร์จที่ได้รับอนุมัติไว้ก่อนหน้านี้เพื่อทำการชำระเงินให้เสร็จสมบูรณ์ ใช้สำหรับเวิร์กโฟลว์การอนุมัติล่วงหน้าที่คุณอนุมัติก่อน (ด้วย capture=false) แล้วจับเงินในภายหลัง

---

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

▼

---

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

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

▼

`id`STRING(required)

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

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องขึ้นต้นด้วย chrg_, ต้องเป็นการชาร์จที่ยังไม่ได้จับที่ถูกต้อง, ต้องอยู่ในช่วงเวลาที่สามารถจับได้ (7 วัน)

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

▼

---

การตอบกลับ

200

จับสำเร็จ

จับการชาร์จสำเร็จ การชำระเงินเสร็จสมบูรณ์และโอนเงินแล้ว

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

• capture - เปลี่ยนจาก false เป็น true
• paid - เปลี่ยนจาก false เป็น true
• capturable - เปลี่ยนจาก true เป็น false
• refundable - เปลี่ยนจาก false เป็น true
• paid_at - ตั้งค่าเป็นเวลาปัจจุบัน

400

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

พารามิเตอร์ที่ไม่ถูกต้องถูกส่งมา

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

• capture_amount ไม่ถูกต้อง (เกินจำนวนที่ได้รับอนุมัติ)
• รูปแบบ ID การชาร์จไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

ID การชาร์จไม่มีอยู่

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

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

422

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

ไม่สามารถจับการชาร์จได้

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

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

---

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

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

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

Code	คำอธิบาย	วิธีแก้ไข
not_found	ID การชาร์จไม่มีอยู่	ตรวจสอบว่า ID การชาร์จถูกต้อง
already_captured	การชาร์จถูกจับแล้ว	ตรวจสอบสถานะการชาร์จก่อนจับ
not_capturable	ไม่สามารถจับการชาร์จได้	ตรวจสอบว่าฟิลด์ capturable เป็น true
capture_amount_too_high	จำนวนเงินเกินจำนวนที่ได้รับอนุมัติ	ลด capture_amount
authorization_expired	การอนุมัติล่วงหน้าหมดอายุแล้ว (เกิน 7 วัน)	สร้างการชาร์จใหม่

สถานะการชาร์จหลังจากการจับ

Field	ก่อนจับ	หลังจับ
capture	false	true
paid	false	true
capturable	true	false
refundable	false	true
paid_at	null	ISO 8601 timestamp

---

ลองใช้งาน

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

▼

id(จำเป็น)

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

▼